aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/settings.md
diff options
context:
space:
mode:
authorTom Christie2012-11-16 13:45:27 -0800
committerTom Christie2012-11-16 13:45:27 -0800
commit9973cf329a2133a900256b53236348ef3c870842 (patch)
tree51dc6ace4f81f6137a2c8249b2ba8f88e8531480 /docs/api-guide/settings.md
parent8d3581f4bd9b0abbf88a7713a1cb8b67f820602a (diff)
parenta701a21587a69ed959533cbcfdaa9c63337c3ccc (diff)
downloaddjango-rest-framework-9973cf329a2133a900256b53236348ef3c870842.tar.bz2
Merge pull request #412 from minddust/custom_page_size_per_request
support for custom page size per request
Diffstat (limited to 'docs/api-guide/settings.md')
-rw-r--r--docs/api-guide/settings.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md
index 4f87b30d..8fce9e4e 100644
--- a/docs/api-guide/settings.md
+++ b/docs/api-guide/settings.md
@@ -150,4 +150,14 @@ Default: `'accept'`
Default: `'format'`
+## PAGE_SIZE_KWARG
+
+Allows you to globally pass a page size parameter for an individual request.
+
+The name of the GET parameter of views which inherit ListModelMixin for requesting data with an individual page size.
+
+If the value if this setting is `None` the passing a page size is turned off by default.
+
+Default: `'page_size'`
+
[cite]: http://www.python.org/dev/peps/pep-0020/