Conversation
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
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.
What type of PR is this?
What this PR does / why we need it:
This PR updates the CAMARA API Design Guide with comprehensive pagination guidelines. The changes modernize and restructure the pagination section to provide clearer specifications for API implementations. Key updates include:
pageandperPage) with clear default values and constraintsResourceListandPaginationobjectsX-Total-Count,X-Total-Pages, and RFC 8288Linkheaders)seekparameter andContent-Last-KeyheaderThese changes provide API developers with clearer, more standardized pagination implementation guidance aligned with common REST API best practices.
Which issue(s) this PR fixes:
Fixes camaraproject#592
Does this PR introduce a breaking change?
Up to Fall25 pagination was used only in one API (CarrierBilling)
Special notes for reviewers:
seekparameter andContent-Last-Keyheader represents a simplification of the pagination specification rather than a breaking change to the design guide itselfpage=0for the first page. The PR switches to 1-indexed (default: 1, minimum: 1) — both approaches are common in REST APIs, the proposal may be changed hereChangelog input