diff mbox series

docs: Fix documentation of REST_RESULTS_PER_PAGE setting

Message ID 20180826105605.3761-1-andrew.donnellan@au1.ibm.com
State Accepted
Headers show
Series docs: Fix documentation of REST_RESULTS_PER_PAGE setting | expand

Commit Message

Andrew Donnellan Aug. 26, 2018, 10:56 a.m. UTC
In 8fe11180a1a5 ("REST: Add new setting for maximum API page size") I
accidentally deleted the versionadded information for
REST_RESULTS_PER_PAGE. Restore it.

Fixes: 8fe11180a1a5 ("REST: Add new setting for maximum API page size")
Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>
---
 docs/deployment/configuration.rst | 2 ++
 1 file changed, 2 insertions(+)

Comments

Daniel Axtens Aug. 26, 2018, 11:12 a.m. UTC | #1
Andrew Donnellan <andrew.donnellan@au1.ibm.com> writes:

> In 8fe11180a1a5 ("REST: Add new setting for maximum API page size") I
> accidentally deleted the versionadded information for
> REST_RESULTS_PER_PAGE. Restore it.
>
> Fixes: 8fe11180a1a5 ("REST: Add new setting for maximum API page size")
> Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>

Thanks Andrew - applied.

Regards,
Daniel
> ---
>  docs/deployment/configuration.rst | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/docs/deployment/configuration.rst b/docs/deployment/configuration.rst
> index e599522a412b..0601276a3cbc 100644
> --- a/docs/deployment/configuration.rst
> +++ b/docs/deployment/configuration.rst
> @@ -88,6 +88,8 @@ 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``
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -- 
> 2.11.0
diff mbox series

Patch

diff --git a/docs/deployment/configuration.rst b/docs/deployment/configuration.rst
index e599522a412b..0601276a3cbc 100644
--- a/docs/deployment/configuration.rst
+++ b/docs/deployment/configuration.rst
@@ -88,6 +88,8 @@  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``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~