django-rest-framework/docs/api-guide
Adrian Torres 143409230f
Warn about importance of ordering for all pagination classes
The ordering recommendations given for the CursorPagination scheme
actually apply to all pagination schemes, an unsuspecting developer that
implements the more common `LimitOffsetPagination` or
`PageNumberPagination` classes is unlikely to be aware of the importance
of consistent ordering.

This commit moves the `Details and limitations` section out of the
`CursorPagination` section and puts it as the very first subsection of
the `Pagination` page so that it's one of the first things that
developers see.

Some examples of inconsistencies as well as how to deal with them are
given, and an extra way to change the ordering of a paginated view is
provided.

Fixes #6886
2022-05-20 12:28:58 +02:00
..
authentication.md Recommend Django REST Knox (#8490) 2022-05-18 13:10:38 +01:00
caching.md docs: add example for caching (#7118) 2021-03-09 11:49:19 +00:00
content-negotiation.md Update mkdocs (#6769) 2019-06-30 19:04:36 -07:00
exceptions.md Provide example for dict in ValidationError detail (#7788) 2021-03-08 11:46:35 +00:00
fields.md Update description of docs/api-guide/fields.md -> required (#8476) 2022-05-03 11:10:37 +01:00
filtering.md Update filtering.md (#8331) 2022-01-17 09:41:23 +00:00
format-suffixes.md Correct variable name (#8306) 2021-12-22 15:17:57 +00:00
generic-views.md Highlight select_related and prefetch_related usage in documentation (#7610) 2021-10-05 15:33:55 +01:00
metadata.md Fix schema endpoint example (#7178) 2020-05-05 14:04:35 +01:00
pagination.md Warn about importance of ordering for all pagination classes 2022-05-20 12:28:58 +02:00
parsers.md docs: outline the difference between JSON and form parsers. Fix #7633 2020-11-12 09:48:18 +01:00
permissions.md Update permissions.md (#8260) 2021-12-08 14:35:06 +00:00
relations.md corrected grammar to improve clarity (#8466) 2022-04-14 21:00:38 +01:00
renderers.md We've renamed the drf-renderer-xlsx package to drf-excel. (#8396) 2022-03-08 10:39:16 +00:00
requests.md docs: outline the difference between JSON and form parsers. Fix #7633 2020-11-12 09:48:18 +01:00
responses.md Fix link to Django docs (#7040) 2019-11-06 09:34:28 -08:00
reverse.md Update mkdocs (#6769) 2019-06-30 19:04:36 -07:00
routers.md Replace all url() calls with path() or re_path() (#7512) 2020-09-08 15:32:27 +01:00
schemas.md FIX: Broken cite. (#7951) 2021-04-26 09:30:41 +01:00
serializers.md Fixed missing "fields" meta argument in docs (#8243) 2021-12-17 15:20:14 +00:00
settings.md Update DEFAULT_SCHEMA_CLASSES default value in Settings docs (#7014) 2019-11-06 21:37:13 +01:00
status-codes.md Update mkdocs (#6769) 2019-06-30 19:04:36 -07:00
testing.md Link added for Test Case Classes and corrected stable link for Refresh from DB (#8381) 2022-03-23 12:07:44 +00:00
throttling.md docs: Add a note on concurrency and races (#6950) 2022-04-24 23:16:18 +01:00
validators.md fix typo (#8122) 2021-08-11 11:30:09 +01:00
versioning.md Updated url() with re_path() in Versioning docs. (#7043) 2019-11-07 13:20:56 +01:00
views.md Imported Response (#8207) 2021-10-07 15:52:44 +01:00
viewsets.md IsAdmin permissions changed to IsAdminUser (#8227) 2021-12-08 14:33:41 +00:00