Add openapi schema extension

grafana · Jul 8, 2024 · 0b8e69c · 0b8e69c
1 parent 5f3090c
commit 0b8e69c
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/engine/apps/api/views/user.py b/engine/apps/api/views/user.py
@@ -842,6 +842,27 @@ def export_token(self, request, pk) -> Response:
             return Response(status=status.HTTP_204_NO_CONTENT)
         return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)
 
+    @extend_schema(
+        responses=inline_serializer(
+            name="UserFilters",
+            fields={
+                "name": serializers.CharField(),
+                "type": serializers.CharField(),
+                "href": serializers.CharField(required=False),
+                "global": serializers.BooleanField(required=False),
+                "default": serializers.JSONField(required=False),
+                "description": serializers.CharField(required=False),
+                "options": inline_serializer(
+                    name="UserFiltersOptions",
+                    fields={
+                        "value": serializers.CharField(),
+                        "display_name": serializers.IntegerField(),
+                    },
+                ),
+            },
+            many=True,
+        )
+    )
     @action(methods=["get"], detail=False)
     def filters(self, request):
         filter_name = request.query_params.get("search", None)