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

Revert "Improve documentation regarding serializer class on extra actions." partially

Browse Source 
This reverts commit 963607a184 partially.
It is just a specific example of the already documented "can take extra
arguments". The fix for the example was not reverted.
This commit is contained in:
Soeren Wegener 2019-01-18 13:34:04 +01:00
parent 963607a184
commit f5c3bd0ce5
1 changed files with 0 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -129,11 +129,6 @@ You may inspect these attributes to adjust behaviour based on the current action
If you have ad-hoc methods that should be routable, you can mark them as such with the `@action` decorator. Like regular actions, extra actions may be intended for either a single object, or an entire collection. To indicate this, set the `detail` argument to `True` or `False`. The router will configure its URL patterns accordingly. e.g., the `DefaultRouter` will configure detail actions to contain `pk` in their URL patterns.
Your custom action may use a different [Serializer class](serializers.md). To make sure that the generated docs display a form which matches your serializer, you have two options:
* Either: provide a `serializer_class=MySerializer` argument to the `@action()` decorator (see example below)
* Or: override the `get_serializer_class()` method as described in [GenericAPIView](generic-views.md#genericapiview)
A more complete example of extra actions:
from django.contrib.auth.models import User