Fixes #18900: raise QuerySetNotOrdered exception when trying to paginate unordered API querysets #19943
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Defines a new exception, `QuerySetNotOrdered`, and raises it in `OptionalLimitOffsetPagination.paginate_queryset` in the right conditions: - the iterable to be paginated is a QuerySet isinstance - the `queryset.ordered` flag is not truthy
I chose to implement this here for TaggedItemViewSet, rather than on the model, because any meaningful ordering is going to be done on the related Tag instance and I didn't want to introduce potential, not well understood side-effects by applying a model-wide ordering via a related model field.
jnovinger
requested review from
a team and
bctiemann
and removed request for
a team
bctiemann
previously approved these changes
Jul 29, 2025
bctiemann
approved these changes
Jul 29, 2025
jnovinger
deleted the
18900-paginator-should-not-paginate-unsorted-queryset
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #18900
QuerySetNotOrderedexception when an API endpoint tries to paginate a queryset instance that has not been ordered or has lost its ordering (see Netbox API returns duplicate resources during paging with offset #18729).reapply_model_ordering()to not reapply default orderings if queryset is already ordered.users.Tokenmodel