From 280014fe37c57f7068c42e9c2f644c685c48b909 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Tue, 2 Jul 2019 04:09:45 -0700 Subject: [PATCH] Update docs for pagination settings (#6772) --- docs/api-guide/settings.md | 45 +++++--------------------------------- 1 file changed, 6 insertions(+), 39 deletions(-) diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 1da79a477..03f4b9def 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -109,32 +109,19 @@ Default: `'rest_framework.schemas.AutoSchema'` *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 A list of filter backend classes that should be used for generic filtering. 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.** - -See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style). - ---- +Default: `None` #### PAGE_SIZE @@ -142,26 +129,6 @@ The default page size to use for pagination. If set to `None`, pagination is di 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 The name of a query parameter, which can be used to specify the search term used by `SearchFilter`.