Skip to content
This repository has been archived by the owner on Mar 29, 2023. It is now read-only.

[Api2] [Doc] Pagination (documentation) #95

Open
rubenhorn opened this issue Feb 18, 2022 · 1 comment
Open

[Api2] [Doc] Pagination (documentation) #95

rubenhorn opened this issue Feb 18, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@rubenhorn
Copy link
Collaborator

rubenhorn commented Feb 18, 2022

Pagination in the API should be implemented as an extension to JSend.
A successful response may include the field nextPage (null, if it does not exist) and should accept the query parameter page with a default value if not present.

Example request:

GET /some/path?page=<PAGE_ID>

Example response:

{
   "status": "success",
   "data": { ... },
   "nextPage": <PAGE_ID>
}

⚠ Please update the API documentation when implementing pagination.
(This ticket should remain open until all "legacy" features have been switched to pagination)

@rubenhorn rubenhorn added the documentation Improvements or additions to documentation label Feb 18, 2022
@rubenhorn rubenhorn changed the title [Api2][Doc] Pagination (documentation) [Api2] [Doc] Pagination (documentation) Feb 19, 2022
@rubenhorn
Copy link
Collaborator Author

rubenhorn commented Mar 21, 2022

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant