Skip to content

Commit 59c439d

Browse files
n2ygksliverc
authored andcommitted
Rename JSONAPIOrderingFilter back to OrderingFilter (#477)
1 parent 7fa46c2 commit 59c439d

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ override ``settings.REST_FRAMEWORK``
173173
),
174174
'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
175175
'DEFAULT_FILTER_BACKENDS': (
176-
'rest_framework_json_api.filters.JSONAPIOrderingFilter',
176+
'rest_framework_json_api.filters.OrderingFilter',
177177
'rest_framework_json_api.django_filters.DjangoFilterBackend',
178178
),
179179
'TEST_REQUEST_RENDERER_CLASSES': (

docs/usage.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ REST_FRAMEWORK = {
3333
),
3434
'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
3535
'DEFAULT_FILTER_BACKENDS': (
36-
'rest_framework_json_api.filters.JSONAPIOrderingFilter',
36+
'rest_framework_json_api.filters.OrderingFilter',
3737
'rest_framework_json_api.django_filters.DjangoFilterBackend',
3838
),
3939
'TEST_REQUEST_RENDERER_CLASSES': (
@@ -104,8 +104,8 @@ class MyLimitPagination(JsonApiLimitOffsetPagination):
104104

105105
_There are several anticipated JSON:API-specific filter backends in development. The first two are described below._
106106

107-
#### `JSONAPIOrderingFilter`
108-
`JSONAPIOrderingFilter` implements the [JSON:API `sort`](http://jsonapi.org/format/#fetching-sorting) and uses
107+
#### `OrderingFilter`
108+
`OrderingFilter` implements the [JSON:API `sort`](http://jsonapi.org/format/#fetching-sorting) and uses
109109
DRF's [ordering filter](http://django-rest-framework.readthedocs.io/en/latest/api-guide/filtering/#orderingfilter).
110110

111111
Per the JSON:API specification, "If the server does not support sorting as specified in the query parameter `sort`,
@@ -186,7 +186,7 @@ from rest_framework_json_api import django_filters
186186
class MyViewset(ModelViewSet):
187187
queryset = MyModel.objects.all()
188188
serializer_class = MyModelSerializer
189-
filter_backends = (filters.JSONAPIOrderingFilter, django_filters.DjangoFilterBackend,)
189+
filter_backends = (filters.OrderingFilter, django_filters.DjangoFilterBackend,)
190190
```
191191

192192

example/settings/dev.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
),
9191
'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
9292
'DEFAULT_FILTER_BACKENDS': (
93-
'rest_framework_json_api.filters.JSONAPIOrderingFilter',
93+
'rest_framework_json_api.filters.OrderingFilter',
9494
'rest_framework_json_api.django_filters.DjangoFilterBackend',
9595
),
9696
'TEST_REQUEST_RENDERER_CLASSES': (
+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
from .sort import JSONAPIOrderingFilter # noqa: F401
1+
from .sort import OrderingFilter # noqa: F401

rest_framework_json_api/filters/sort.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from rest_framework_json_api.utils import format_value
55

66

7-
class JSONAPIOrderingFilter(OrderingFilter):
7+
class OrderingFilter(OrderingFilter):
88
"""
99
This implements http://jsonapi.org/format/#fetching-sorting and raises 400
1010
if any sort field is invalid. If you prefer *not* to report 400 errors for
@@ -40,5 +40,5 @@ def remove_invalid_fields(self, queryset, fields, view, request):
4040
else:
4141
underscore_fields.append(format_value(item_rewritten, "underscore"))
4242

43-
return super(JSONAPIOrderingFilter, self).remove_invalid_fields(
43+
return super(OrderingFilter, self).remove_invalid_fields(
4444
queryset, underscore_fields, view, request)

0 commit comments

Comments
 (0)