Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce Pagination #15

Open
13 tasks
niden opened this issue Aug 8, 2018 · 0 comments
Open
13 tasks

Introduce Pagination #15

niden opened this issue Aug 8, 2018 · 0 comments
Labels
enhancement New feature or request

Comments

@niden
Copy link
Sponsor Member

niden commented Aug 8, 2018

  • A server MAY choose to limit the number of resources returned in a response to a subset (“page”) of the whole set available.
  • A server MAY provide links to traverse a paginated data set (“pagination links”).
  • Pagination links MUST appear in the links object that corresponds to a collection. To paginate the primary data, supply pagination links in the top-level links object. To paginate an included collection returned in a compound document, supply pagination links in the corresponding links object.
  • The following keys MUST be used for pagination links:
  • first: the first page of data
  • last: the last page of data
  • prev: the previous page of data
  • next: the next page of data
  • Keys MUST either be omitted or have a null value to indicate that a particular link is unavailable.
  • Concepts of order, as expressed in the naming of pagination links, MUST remain consistent with JSON API’s sorting rules.
  • The page query parameter is reserved for pagination. Servers and clients SHOULD use this key for - [ ] Introduction of page based pagination.
  • Introduction of page chunk size (config)
  • page[number] is to be used
@niden niden added the enhancement New feature or request label Aug 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant