diff options
| author | Tom Christie | 2013-05-14 11:27:08 +0100 |
|---|---|---|
| committer | Tom Christie | 2013-05-14 11:27:08 +0100 |
| commit | 2cff6e69dbe3828eca56d0ce60ffdfc80fed045c (patch) | |
| tree | 97fd167d13e3d911665687bfd9932d7742f1b276 | |
| parent | 6a037f63edf33e7a76f56828cf68bfae4ccb4f80 (diff) | |
| download | django-rest-framework-2cff6e69dbe3828eca56d0ce60ffdfc80fed045c.tar.bz2 | |
Added OrderingFilter
| -rw-r--r-- | docs/api-guide/filtering.md | 2 | ||||
| -rw-r--r-- | rest_framework/filters.py | 2 | ||||
| -rw-r--r-- | rest_framework/tests/filters.py | 6 |
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md index 7e99832e..a710ad7d 100644 --- a/docs/api-guide/filtering.md +++ b/docs/api-guide/filtering.md @@ -216,7 +216,7 @@ For more details, see the [Django documentation][search-django-admin]. ## OrderingFilter -The `OrderingFilter` class supports simple query parameter controlled ordering of results. For example: +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: http://example.com/api/users?ordering=username diff --git a/rest_framework/filters.py b/rest_framework/filters.py index 308e7da2..6a3e055d 100644 --- a/rest_framework/filters.py +++ b/rest_framework/filters.py @@ -112,7 +112,7 @@ class SearchFilter(BaseFilterBackend): class OrderingFilter(BaseFilterBackend): - ordering_param = 'order' # The URL query parameter used for the ordering. + ordering_param = 'ordering' # The URL query parameter used for the ordering. def get_ordering(self, request): """ diff --git a/rest_framework/tests/filters.py b/rest_framework/tests/filters.py index 6b604deb..b20d5980 100644 --- a/rest_framework/tests/filters.py +++ b/rest_framework/tests/filters.py @@ -369,7 +369,7 @@ class OrderingFilterTests(TestCase): ordering = ('title',) view = OrderingListView.as_view() - request = factory.get('?order=text') + request = factory.get('?ordering=text') response = view(request) self.assertEqual( response.data, @@ -387,7 +387,7 @@ class OrderingFilterTests(TestCase): ordering = ('title',) view = OrderingListView.as_view() - request = factory.get('?order=-text') + request = factory.get('?ordering=-text') response = view(request) self.assertEqual( response.data, @@ -405,7 +405,7 @@ class OrderingFilterTests(TestCase): ordering = ('title',) view = OrderingListView.as_view() - request = factory.get('?order=foobar') + request = factory.get('?ordering=foobar') response = view(request) self.assertEqual( response.data, |