Skip to content

Commit 2cff6e6

Browse files
Added OrderingFilter
1 parent 6a037f6 commit 2cff6e6

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/api-guide/filtering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ For more details, see the [Django documentation][search-django-admin].
216216

217217
## OrderingFilter
218218

219-
The `OrderingFilter` class supports simple query parameter controlled ordering of results. For example:
219+
The `OrderingFilter` class supports simple query parameter controlled ordering of results. To specify the result order, set a query parameter named `'order'` to the required field name. For example:
220220

221221
http://example.com/api/users?ordering=username
222222

rest_framework/filters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ def filter_queryset(self, request, queryset, view):
112112

113113

114114
class OrderingFilter(BaseFilterBackend):
115-
ordering_param = 'order' # The URL query parameter used for the ordering.
115+
ordering_param = 'ordering' # The URL query parameter used for the ordering.
116116

117117
def get_ordering(self, request):
118118
"""

rest_framework/tests/filters.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ class OrderingListView(generics.ListAPIView):
369369
ordering = ('title',)
370370

371371
view = OrderingListView.as_view()
372-
request = factory.get('?order=text')
372+
request = factory.get('?ordering=text')
373373
response = view(request)
374374
self.assertEqual(
375375
response.data,
@@ -387,7 +387,7 @@ class OrderingListView(generics.ListAPIView):
387387
ordering = ('title',)
388388

389389
view = OrderingListView.as_view()
390-
request = factory.get('?order=-text')
390+
request = factory.get('?ordering=-text')
391391
response = view(request)
392392
self.assertEqual(
393393
response.data,
@@ -405,7 +405,7 @@ class OrderingListView(generics.ListAPIView):
405405
ordering = ('title',)
406406

407407
view = OrderingListView.as_view()
408-
request = factory.get('?order=foobar')
408+
request = factory.get('?ordering=foobar')
409409
response = view(request)
410410
self.assertEqual(
411411
response.data,

0 commit comments

Comments
 (0)