Improve documentation regarding serializer class on extra actions. #6410
Conversation
The documentation does currently not describe how to use a custom `serializer_class` with extra actions. The example uses a custom serializer without using the seralizer_class attribute, resulting in the generated documentation page presenting the wrong form. The author of the feature described the usage of the `serializer_class` kwarg in his pr #5605: #5605 (comment)
|
Hi, Thank you for the contribution. |
…ions." partially This reverts commit 963607a partially. It is just a specific example of the already documented "can take extra arguments". The fix for the example was not reverted.
|
I see, actually, right after the example, it says exactly that. I just didn't get it. Still, I would like to contribute the fix of the example code, passing the |
| @@ -144,7 +144,7 @@ A more complete example of extra actions: | |||
| queryset = User.objects.all() | |||
| serializer_class = UserSerializer | |||
|
|
|||
| @action(detail=True, methods=['post']) | |||
| @action(detail=True, methods=['post'], serializer_class=PasswordSerializer) | |||
There was a problem hiding this comment.
Can we then use self.get_serializer() in the method body? (Otherwise the kwarg isn’t doing anything...)
(Although see main comment.)
|
The kwarg is necessary, regardless of usage inside the function. Without the kwarg, the generated doc will show the I feel that it might be common that extra actions have other inputs than the normal actions. Therefore I think it's a good idea to show correct usage of another serializer. |
|
Hi @soerface. Yes, right. I'm thinking then we should rephrase a little bit to spell that out. (Note emphasis on little.) Happy if you want have a pop at that. If not I'll give it a look over. |
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
The documentation does currently not describe how to use a custom
serializer_classwith extra actions. The example uses a custom serializer without using the seralizer_class attribute, resulting in the generated documentation page presenting the wrong form.The author of the feature described the usage of the
serializer_classkwarg in his PR #5605 (comment)