From c90cf828aeda3ebb1a599064ee6c39c03eb04242 Mon Sep 17 00:00:00 2001 From: Xavier Ordoquy Date: Tue, 8 Mar 2016 06:40:33 +0100 Subject: [PATCH] PAGE_SIZE addition in 3.1 --- docs/api-guide/settings.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 4de23b1fd..142cd7ebc 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -127,18 +127,9 @@ See the pagination documentation for further guidance on [setting the pagination --- -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. +#### PAGE_SIZE -For example, given the following settings: - - REST_FRAMEWORK = { - 'PAGINATE_BY': 10, - 'PAGINATE_BY_PARAM': 'page_size', - } - -A client would be able to modify the pagination size by using the `page_size` query parameter. For example: - - GET http://example.com/api/accounts?page_size=25 +The default page size to use for pagination. If set to `None`, pagination is disabled by default. Default: `None`