encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-29 04:54:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

PAGINATE_BY_PARAM and MAX_PAGINATE_BY removed in 3.3

Browse Source
This commit is contained in:
Xavier Ordoquy 2016-03-08 06:41:08 +01:00
parent c90cf828ae
commit c91229aaab
1 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/api-guide/settings.md
View File

@ -133,6 +133,16 @@ The default page size to use for pagination. If set to `None`, pagination is di
Default: `None` Default: `None`
#### PAGINATE_BY_PARAM
---
**This setting has been removed.**
See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).
---
#### MAX_PAGINATE_BY #### MAX_PAGINATE_BY
--- ---
@ -143,22 +153,6 @@ See the pagination documentation for further guidance on [setting the pagination
--- ---
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:
REST_FRAMEWORK = {
'PAGINATE_BY': 10,
'PAGINATE_BY_PARAM': 'page_size',
'MAX_PAGINATE_BY': 100
}
A client request like the following would return a paginated list of up to 100 items.
GET http://example.com/api/accounts?page_size=999
Default: `None`
### SEARCH_PARAM ### SEARCH_PARAM
The name of a query parameter, which can be used to specify the search term used by `SearchFilter`. The name of a query parameter, which can be used to specify the search term used by `SearchFilter`.