encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-02-16 19:41:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update filtering docs (#6467)

Browse Source
This commit is contained in:
Ryan P Kilby 2019-02-22 10:58:01 -08:00 committed by GitHub
parent d932baa646
commit 286cf57a8d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/api-guide/filtering.md
View File

@ -127,7 +127,7 @@ Note that you can use both an overridden `.get_queryset()` and generic filtering
""" """
model = Product model = Product
serializer_class = ProductSerializer serializer_class = ProductSerializer
filter_class = ProductFilter filterset_class = ProductFilter
def get_queryset(self): def get_queryset(self):
user = self.request.user user = self.request.user
@ -305,9 +305,9 @@ A complete example using both `DjangoObjectPermissionsFilter` and `DjangoObjectP
**permissions.py**: **permissions.py**:
class CustomObjectPermissions(permissions.DjangoObjectPermissions): class CustomObjectPermissions(permissions.DjangoObjectPermissions):
""" """
Similar to `DjangoObjectPermissions`, but adding 'view' permissions. Similar to `DjangoObjectPermissions`, but adding 'view' permissions.
""" """
perms_map = { perms_map = {
'GET': ['%(app_label)s.view_%(model_name)s'], 'GET': ['%(app_label)s.view_%(model_name)s'],
'OPTIONS': ['%(app_label)s.view_%(model_name)s'], 'OPTIONS': ['%(app_label)s.view_%(model_name)s'],
@ -321,11 +321,11 @@ A complete example using both `DjangoObjectPermissionsFilter` and `DjangoObjectP
**views.py**: **views.py**:
class EventViewSet(viewsets.ModelViewSet): class EventViewSet(viewsets.ModelViewSet):
""" """
Viewset that only lists events if user has 'view' permissions, and only Viewset that only lists events if user has 'view' permissions, and only
allows operations on individual events if user has appropriate 'view', 'add', allows operations on individual events if user has appropriate 'view', 'add',
'change' or 'delete' permissions. 'change' or 'delete' permissions.
""" """
queryset = Event.objects.all() queryset = Event.objects.all()
serializer_class = EventSerializer serializer_class = EventSerializer
filter_backends = (filters.DjangoObjectPermissionsFilter,) filter_backends = (filters.DjangoObjectPermissionsFilter,)