From f5c3bd0ce5524999eaa8521969cf0b2d9cecf33e Mon Sep 17 00:00:00 2001 From: Soeren Wegener Date: Fri, 18 Jan 2019 13:34:04 +0100 Subject: [PATCH] Revert "Improve documentation regarding serializer class on extra actions." partially This reverts commit 963607a1841fd98d17a2a3cfe690902f7204b915 partially. It is just a specific example of the already documented "can take extra arguments". The fix for the example was not reverted. --- docs/api-guide/viewsets.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/api-guide/viewsets.md b/docs/api-guide/viewsets.md index ada6367bf..701920d33 100644 --- a/docs/api-guide/viewsets.md +++ b/docs/api-guide/viewsets.md @@ -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