Better API documentation.

This commit is contained in:
Antoine Nguyen
2022-09-17 10:40:06 +02:00
parent fbada3fadd
commit 43020542f8
2 changed files with 14 additions and 3 deletions
+7
View File
@@ -34,3 +34,10 @@ class StructureSerializer(serializers.Serializer):
name = serializers.CharField()
display = serializers.CharField(help_text="Display rule")
parameters = ParameterSerializer(many=True)
class AppParametersSerializer(serializers.Serializer):
"""Serializer for application parameters."""
label = serializers.CharField()
params = serializers.DictField()
+7 -3
View File
@@ -36,15 +36,19 @@ class ParametersViewSet(viewsets.ViewSet):
description='A registered application name',
type=str, required=True
),
]
],
responses=serializers.AppParametersSerializer
)
def retrieve(self, request, pk: str):
"""Return all parameters for given app."""
parameters = request.localconfig.parameters.get_values_dict(pk)
serializer = tools.registry.get_serializer_class("global", pk)(
parameters)
data = {"params":serializer.data, "label":tools.registry.get_label("global", pk)}
return response.Response(data)
result = serializers.AppParametersSerializer({
"label": tools.registry.get_label("global", pk),
"params": serializer.data
})
return response.Response(result.data)
@extend_schema(
parameters=[