Commit f9c61e80 by Tom Christie

Prominent notes on deprecation status of pagination settings. Closes #3173.

parent 7b213368
...@@ -119,6 +119,14 @@ Default: `None` ...@@ -119,6 +119,14 @@ Default: `None`
#### PAGINATE_BY_PARAM #### PAGINATE_BY_PARAM
---
**This setting is pending deprecation.**
See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).
---
The name of a query parameter, which can be used by the client to override the default page size to use for pagination. If set to `None`, clients may not override the default page size. The name of a query parameter, which can be used by the client to override the default page size to use for pagination. If set to `None`, clients may not override the default page size.
For example, given the following settings: For example, given the following settings:
...@@ -136,6 +144,14 @@ Default: `None` ...@@ -136,6 +144,14 @@ Default: `None`
#### MAX_PAGINATE_BY #### MAX_PAGINATE_BY
---
**This setting is pending deprecation.**
See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).
---
The maximum page size to allow when the page size is specified by the client. If set to `None`, then no maximum limit is applied. The maximum page size to allow when the page size is specified by the client. If set to `None`, then no maximum limit is applied.
For example, given the following settings: For example, given the following settings:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment