Skip to content

Commit

Permalink
Prominent notes on deprecation status of pagination settings. Closes #…
Browse files Browse the repository at this point in the history
  • Loading branch information
tomchristie committed Jul 22, 2015
1 parent 7b21336 commit f9c61e8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/api-guide/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,14 @@ Default: `None`

#### PAGINATE_BY_PARAM

---

**This setting is pending deprecation.**

See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).

---

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.

For example, given the following settings:
Expand All @@ -136,6 +144,14 @@ Default: `None`

#### MAX_PAGINATE_BY

---

**This setting is pending deprecation.**

See the pagination documentation for further guidance on [setting the pagination style](pagination.md#modifying-the-pagination-style).

---

The maximum page size to allow when the page size is specified by the client. If set to `None`, then no maximum limit is applied.

For example, given the following settings:
Expand Down

0 comments on commit f9c61e8

Please sign in to comment.