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

Update docs for pagination settings (#6772)

Browse Source
This commit is contained in:
Ryan P Kilby 2019-07-02 04:09:45 -07:00 committed by Tom Christie
parent 41d5338ba6
commit 280014fe37
1 changed files with 6 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -109,32 +109,19 @@ Default: `'rest_framework.schemas.AutoSchema'`
*The following settings control the behavior of the generic class-based views.* *The following settings control the behavior of the generic class-based views.*
#### DEFAULT_PAGINATION_SERIALIZER_CLASS
---
**This setting has been removed.**
The pagination API does not use serializers to determine the output format, and
you'll need to instead override the `get_paginated_response method on a
pagination class in order to specify how the output format is controlled.
---
#### DEFAULT_FILTER_BACKENDS #### DEFAULT_FILTER_BACKENDS
A list of filter backend classes that should be used for generic filtering. A list of filter backend classes that should be used for generic filtering.
If set to `None` then generic filtering is disabled. If set to `None` then generic filtering is disabled.
#### PAGINATE_BY #### DEFAULT_PAGINATION_CLASS
--- The default class to use for queryset pagination. If set to `None`, pagination
is disabled by default. See the pagination documentation for further guidance on
[setting](pagination.md#setting-the-pagination-style) and
[modifying](pagination.md#modifying-the-pagination-style) the pagination style.
**This setting has been removed.** Default: `None`
See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).
---
#### PAGE_SIZE #### PAGE_SIZE
@ -142,26 +129,6 @@ 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
---
**This setting has been removed.**
See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).
---
### 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`.