Skip to content

renamed JSONAPIOrderingFilter to OrderingFilter #477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 14, 2018
Merged

renamed JSONAPIOrderingFilter to OrderingFilter #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ override ``settings.REST_FRAMEWORK``
),
'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
'DEFAULT_FILTER_BACKENDS': (
'rest_framework_json_api.filters.JSONAPIOrderingFilter',
'rest_framework_json_api.filters.OrderingFilter',
'rest_framework_json_api.django_filters.DjangoFilterBackend',
),
'TEST_REQUEST_RENDERER_CLASSES': (
Expand Down
8 changes: 4 additions & 4 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ REST_FRAMEWORK = {
),
'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
'DEFAULT_FILTER_BACKENDS': (
'rest_framework_json_api.filters.JSONAPIOrderingFilter',
'rest_framework_json_api.filters.OrderingFilter',
'rest_framework_json_api.django_filters.DjangoFilterBackend',
),
'TEST_REQUEST_RENDERER_CLASSES': (
Expand Down Expand Up @@ -104,8 +104,8 @@ class MyLimitPagination(JsonApiLimitOffsetPagination):

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

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

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


Expand Down
2 changes: 1 addition & 1 deletion example/settings/dev.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
),
'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata',
'DEFAULT_FILTER_BACKENDS': (
'rest_framework_json_api.filters.JSONAPIOrderingFilter',
'rest_framework_json_api.filters.OrderingFilter',
'rest_framework_json_api.django_filters.DjangoFilterBackend',
),
'TEST_REQUEST_RENDERER_CLASSES': (
Expand Down
2 changes: 1 addition & 1 deletion rest_framework_json_api/filters/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
from .sort import JSONAPIOrderingFilter # noqa: F401
from .sort import OrderingFilter # noqa: F401
4 changes: 2 additions & 2 deletions rest_framework_json_api/filters/sort.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from rest_framework_json_api.utils import format_value


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

return super(JSONAPIOrderingFilter, self).remove_invalid_fields(
return super(OrderingFilter, self).remove_invalid_fields(
queryset, underscore_fields, view, request)