Improve pagination documentation. #7
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
…ust have a sort order specified. Fix position numbers in offset description.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When I execute the example call in the documentation, I don't always get the same results.
Based on my observations, it looks like there is no default sort order, because multiple requests not having a sort order return different results, whereas those containing a sort order always return the same results.
Although this was a surprise to me, it probably shouldn't have been. The server doesn't (can't) save any state between requests, and there is no concept of a result set to be iterated over in multiple requests...right?
So I added some text to clarify this. Also, I think the numbers in the offset example were off, so I changed them.
Regarding documentation of pagination, clarify that paged responses must have a sort order specified.
Fix position numbers in offset description.