Clarify pagination requirements and recommended page size (#981)#982
Open
zeulus wants to merge 1 commit into
Open
Clarify pagination requirements and recommended page size (#981)#982zeulus wants to merge 1 commit into
zeulus wants to merge 1 commit into
Conversation
Add a shared Pagination section to general-information.md documenting the JSON:API page[number]/page[size] query parameters, the links object, and recommended page sizes (minimum 500, default 1000; maximum left to the provider/agency to document). Point the provider, agency, and policy specs at it and drop the duplicated keys/example from the provider spec. Note that policy pagination is optional. Refs openmobilityfoundation#981
schnuerle
added
the
minor update
Contributor
|
Looks good to me! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Explain pull request
Moves the core pagination details into
general-information.mdand has the per-API specs link to that shared section. Documents the JSON:APIpage[number]/page[size]query parameters (previously undocumented in MDS) and recommends a minimum supportedpage[size]of 500 and a default of 1000, leaving the maximum for each provider/agency to document. Thelinkskeys and example move out ofprovider/README.mdinto the shared section, and Policy pagination is noted as optional.Is this a breaking change
Impacted Spec
generalagencyproviderpolicyAdditional context
See #981