Skip to content

Commit 88fcf6b

Browse files
author
Eric Hurst
committed
Add documentation for default page_query_param
1 parent 0510887 commit 88fcf6b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/usage.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ REST_FRAMEWORK = {
3131

3232
If `PAGE_SIZE` is set the renderer will return a `meta` object with
3333
record count and a `links` object with the next, previous, first, and last links.
34-
Pages can be selected with the `page` GET parameter. Page size can be controlled
35-
per request via the `PAGINATE_BY_PARAM` query parameter (`page_size` by default).
34+
Pages can be selected with the `page` GET parameter. The query parameter used to
35+
retrieve the page can be customized by subclassing `PageNumberPagination` and
36+
overriding the `page_query_param`. Page size can be controlled per request via
37+
the `PAGINATE_BY_PARAM` query parameter (`page_size` by default).
3638

3739
### Serializers
3840

0 commit comments

Comments
 (0)