Fix for query public API spec - was missing description of parameters property #5140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… put properties for a query when running through the public API - fixing the spec.
Rory-Powell
approved these changes
Mar 29, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix for #5117 - this issue raised a point that the docs didn't describe where to put properties for a query when running through the public API - fixing the spec. Couldn't just pass the whole body through as this would mean that REST pagination couldn't be used, so I've documented the
parametersproperty of the body, as well as thepaginationstructure used by REST queries (as well as documenting it is only for REST).