Skip to content

Commit

Permalink
docs for #1498
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaiarocci committed Mar 14, 2023
1 parent 415fbf8 commit 38d99f2
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,14 +158,14 @@ uppercase.
overridden by resource settings. Defaults
to ``True``.

``PAGINATION_LIMIT`` Maximum value allowed for QUERY_MAX_RESULTS
``PAGINATION_LIMIT`` Maximum value allowed for ``QUERY_MAX_RESULTS``
query parameter. Values exceeding the
limit will be silently replaced with this
value. You want to aim for a reasonable
compromise between performance and transfer
size. Defaults to 50.

``PAGINATION_DEFAULT`` Default value for QUERY_MAX_RESULTS.
``PAGINATION_DEFAULT`` Default value for ``QUERY_MAX_RESULTS``.
Defaults to 25.

``OPTIMIZE_PAGINATION_FOR_SPEED`` Set this to ``True`` to improve pagination
Expand Down Expand Up @@ -868,6 +868,13 @@ always lowercase.
``pagination`` ``True`` if pagination is enabled, ``False``
otherwise. Locally overrides ``PAGINATION``.

``pagination_limit`` Maximum value allowed for ``QUERY_MAX_RESULTS``
query parameter. Values exceeding the
limit will be silently replaced with this
value. You want to aim for a reasonable
compromise between performance and transfer
size. Defaults to 50.

``resource_methods`` A list of HTTP methods supported at resource
endpoint. Allowed values: ``GET``, ``POST``,
``DELETE``. Locally overrides
Expand Down

0 comments on commit 38d99f2

Please sign in to comment.