diff options
| author | Andrew Donnellan <andrew.donnellan@au1.ibm.com> | 2018-07-24 15:10:51 +1000 |
|---|---|---|
| committer | Daniel Axtens <dja@axtens.net> | 2018-08-26 17:48:25 +1000 |
| commit | 8fe11180a1a59f6e8e5a4441b21a3d9831f0b69d (patch) | |
| tree | bb2ace3b2af2e40d9825b5e56c9ae3be44ad2a44 /docs | |
| parent | 0b5b4e8cb3d04e6f25ff73825d34632c61b353d1 (diff) | |
| download | patchwork-8fe11180a1a59f6e8e5a4441b21a3d9831f0b69d.tar patchwork-8fe11180a1a59f6e8e5a4441b21a3d9831f0b69d.tar.gz | |
REST: Add new setting for maximum API page size
In 41790caf59ad ("REST: Limit max page size") we limited the maximum page
size to the default page size in the settings.
This turns out to be rather restrictive, as we usually want to keep the
default page size low, but an administrator may want to allow API clients
to fetch more than that per request.
Add a new setting, MAX_REST_RESULTS_PER_PAGE, to set the maximum page size.
Closes: #202 ("Separate max API page size and default API page size into different settings")
Suggested-by: Stewart Smith <stewart@linux.ibm.com>
Suggested-by: Joel Stanley <joel@jms.id.au>
Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>
[dja: set to 250 as per mailing list discussion]
Signed-off-by: Daniel Axtens <dja@axtens.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/deployment/configuration.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/deployment/configuration.rst b/docs/deployment/configuration.rst index 3474856..e599522 100644 --- a/docs/deployment/configuration.rst +++ b/docs/deployment/configuration.rst @@ -88,7 +88,13 @@ Enable the :doc:`REST API <../api/rest>`. The number of items to include in REST API responses by default. This can be overridden by the ``per_page`` parameter for some endpoints. -.. versionadded:: 2.0 +``MAX_REST_RESULTS_PER_PAGE`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The maximum number of items that can be requested in a REST API request using +the ``per_page`` parameter. + +.. versionadded:: 2.2 ``COMPAT_REDIR`` ~~~~~~~~~~~~~~~~ |