Provide an easy way to document query params for detail_routes #5382
Description
There does not seem to be an easy way to document query parameters for a detail
view.
-
Would it be feasible to support something like a
input_serializer_class
argument, from where CoreAPI Link Fields (withqueryfor the "Query
Parameters" used indocs/link.html) could be derived from? -
This could then even set
validated_dataon therequest(or pass a new
argument for/with it)?
This would simplify the pattern with:
class CustomInputSerializer(serializers.Serializer):
query_arg = serializers.CharField(required=True)
@detail_route(methods=['get'])
def custom_action(self, request, uuid=None):
"""Some custom action.
Query arguments:
- ``query_arg``:
something, e.g. "2017-08-15" (**required**).
"""
obj = self.get_object()
input = CustomInputSerializer(data=request.GET)
input.is_valid(raise_exception=True)
# Use input.validated_data['query_arg']to
…
@detail_route(methods=['get'])
def custom_action(self, request, uuid=None):
"""Some custom action."""
obj = self.get_object()
# Use request.validated_data['query_arg']