encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-30 18:09:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Slight description of why additional kwargs may be needed with extra actions

Browse Source
This commit is contained in:
Soeren Wegener 2019-01-31 15:25:16 +01:00
parent 0f8e3dd57d
commit ab6d5d05f7
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api-guide/viewsets.md
View File

@ -168,9 +168,9 @@ A more complete example of extra actions:
serializer = self.get_serializer(recent_users, many=True) serializer = self.get_serializer(recent_users, many=True)
return Response(serializer.data) return Response(serializer.data)
The decorator can additionally take extra arguments that will be set for the routed view only. Any class property of the `ViewSet` is therefore a valid argument for `@action()` (e.g. `serializer_class`, `queryset`, `permission_classes`). For example: The decorator can additionally take extra arguments that will be set for the routed view only. Any class property of the `ViewSet` is therefore a valid argument for `@action()` (e.g. `serializer_class`, `queryset`, `permission_classes`). For example, an action which sets a password needs different permissions and a different form to be displayed compared to the regular `UserViewSet`:
@action(detail=True, methods=['post'], permission_classes=[IsAdminOrIsSelf]) @action(detail=True, methods=['post'], permission_classes=[IsAdminOrIsSelf], serializer_class=PasswordSerializer)
def set_password(self, request, pk=None): def set_password(self, request, pk=None):
... ...