Skip to content

Fix inaccurate Pagination section in General API Conventions #299

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.

Sign up for GitHub

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

Merged
jordanpadams merged 1 commit into from
Apr 2, 2026
Merged

Fix inaccurate Pagination section in General API Conventions #299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions docs/source/general-conventions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,18 +159,7 @@ However:
- The version is mandatory in the resource representations (result of a request)


Pagination/Sort
---------------
Pagination
----------

The query parameters for pagination are:

+-----------+---------------------------------------------------------------+
| Parameter | Description |
+===========+===============================================================+
| start | Index of first item returned in the response |
+-----------+---------------------------------------------------------------+
| limit | Maximum number of item expected in the response |
+-----------+---------------------------------------------------------------+

See
`https://www.moesif.com/blog/technical/api-design/REST-API-Design-Filtering-Sorting-and-Pagination/ <https://www.moesif.com/blog/technical/api-design/REST-API-Design-Filtering-Sorting-and-Pagination/>`_
The PDS Search API uses cursor-based pagination via ``search-after`` and ``sort`` parameters, along with ``limit`` to control page size. For detailed usage and examples, see :ref:`guides/search/endpoints:Use pagination to get all products matching a request`.
Loading