mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-07-28 00:49:49 +03:00
Documentation: improve the action decorator documentation (#7316)
This commit is contained in:
parent
e2bd3b6a57
commit
7077943d19
|
@ -171,11 +171,6 @@ 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. For example:
|
|
||||||
|
|
||||||
@action(detail=True, methods=['post'], permission_classes=[IsAdminOrIsSelf])
|
|
||||||
def set_password(self, request, pk=None):
|
|
||||||
...
|
|
||||||
|
|
||||||
The `action` decorator will route `GET` requests by default, but may also accept other HTTP methods by setting the `methods` argument. For example:
|
The `action` decorator will route `GET` requests by default, but may also accept other HTTP methods by setting the `methods` argument. For example:
|
||||||
|
|
||||||
|
@ -183,7 +178,14 @@ The `action` decorator will route `GET` requests by default, but may also accept
|
||||||
def unset_password(self, request, pk=None):
|
def unset_password(self, request, pk=None):
|
||||||
...
|
...
|
||||||
|
|
||||||
The two new actions will then be available at the urls `^users/{pk}/set_password/$` and `^users/{pk}/unset_password/$`
|
|
||||||
|
The decorator allows you to override any viewset-level `*_classes` such as `render_classes` or `permission_classes`:
|
||||||
|
|
||||||
|
@action(detail=True, methods=['post'], permission_classes=[IsAdminOrIsSelf])
|
||||||
|
def set_password(self, request, pk=None):
|
||||||
|
...
|
||||||
|
|
||||||
|
The two new actions will then be available at the urls `^users/{pk}/set_password/$` and `^users/{pk}/unset_password/$`. Use the `url_path` and `url_name` parameters to change the URL segement and the reverse URL name of the action.
|
||||||
|
|
||||||
To view all extra actions, call the `.get_extra_actions()` method.
|
To view all extra actions, call the `.get_extra_actions()` method.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user