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

PAGE_SIZE addition in 3.1

Browse Source
This commit is contained in:
Xavier Ordoquy 2016-03-08 06:40:33 +01:00
parent 180137300f
commit c90cf828ae
1 changed files with 2 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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`