Skip to content

Commit

Permalink
add api docs pagination section (#1489)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikkonie committed Sep 6, 2024
1 parent 631b006 commit 535bdaf
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/source/app_projectroles_api_rest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,25 @@ field upon a successfully processed request.
For creation views, the ``sodar_uuid`` of the created object is returned
along with other object fields.

Pagination
----------

From SODAR Core V1.0 onwards, list views support pagination unless otherwise
specified. Pagination can be enabled by providing the ``?page=x`` query string
in the API request. This will change the return data into a paginated format.
Example:

.. code-block:: python
{
'count' 170,
'next': 'api/url?page=3',
'previous': 'api/url?page=1',
'results': [
# ...
]
}
Projectroles REST API Versioning
================================
Expand Down

0 comments on commit 535bdaf

Please sign in to comment.