diff --git a/docs/reference/contrib/api/configuration.rst b/docs/reference/contrib/api/configuration.rst index 31c66cf749..33dc789339 100644 --- a/docs/reference/contrib/api/configuration.rst +++ b/docs/reference/contrib/api/configuration.rst @@ -16,9 +16,9 @@ Generating URLs to documents will fall back the the current request's hostname i Setting this to false will disable full text search. This applies to all endpoints. -``WAGTAILAPI_MAX_RESULTS`` (default: 20) +``WAGTAILAPI_LIMIT_MAX`` (default: 20) -This allows you to change the maximum number of results a user can get at any time. This applies to all endpoints. +This allows you to change the maximum number of results a user can request at a time. This applies to all endpoints. Adding more fields to the pages endpoint diff --git a/docs/reference/contrib/api/usage.rst b/docs/reference/contrib/api/usage.rst index c230603b62..dc32ec3f8e 100644 --- a/docs/reference/contrib/api/usage.rst +++ b/docs/reference/contrib/api/usage.rst @@ -419,7 +419,7 @@ Like filtering, it is also possible to order on database fields. The endpoint ac Pagination ^^^^^^^^^^ -Pagination is done using two query parameters called ``limit`` and ``offset``. ``limit`` sets the number of results to return and ``offset`` is the index of the first result to return. The default value for ``limit`` is ``20`` and its maximum value is ``100`` (which can be changed using the ``WAGTAILAPI_MAX_RESULTS`` setting). +Pagination is done using two query parameters called ``limit`` and ``offset``. ``limit`` sets the number of results to return and ``offset`` is the index of the first result to return. The default and maximum value for ``limit`` is ``20``. The maximum value can be changed using the ``WAGTAILAPI_LIMIT_MAX`` setting. .. code-block:: json @@ -747,7 +747,7 @@ The images endpoint also accepts the ``order`` parameter which should be set to Pagination ^^^^^^^^^^ -Pagination is done using two query parameters called ``limit`` and ``offset``. ``limit`` sets the number of results to return and ``offset`` is the index of the first result to return. The default value for ``limit`` is ``20`` and its maximum value is ``100`` (which can be changed using the ``WAGTAILAPI_MAX_RESULTS`` setting). +Pagination is done using two query parameters called ``limit`` and ``offset``. ``limit`` sets the number of results to return and ``offset`` is the index of the first result to return. The default and maximum value for ``limit`` is ``20``. The maximum value can be changed using the ``WAGTAILAPI_LIMIT_MAX`` setting. .. code-block:: json