Skip to content

Introduce Pagination #15

@niden

Description

@niden
  • 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions