Fix some openapi definitions.

jasmin_services/api/views.py

@@ -26,7 +26,6 @@ class ServicesViewSet(
     serializer_class = serializers.ServiceSerializer
     action_serializers = {
         "list": serializers.ServiceListSerializer,
-        "roles": serializers.RoleSerializer,
     }
     required_scopes = ["jasmin.services.services.all"]
     filterset_fields = ["category", "hidden", "ceda_managed"]
@@ -41,10 +40,9 @@ class ServicesViewSet(
                 required=False,
                 type=dt.date,
                 description="ISO Date on which you would like to know the active roles for a service.",
-            )
-        ],
-        responses=serializers.RoleSerializer(many=True),
-    )
+            ),
+        ]
+    ),
 )
 class RolesNestedUnderServicesViewSet(rf_viewsets.ReadOnlyModelViewSet):
     """View roles for a service."""
@@ -54,6 +52,10 @@ class RolesNestedUnderServicesViewSet(rf_viewsets.ReadOnlyModelViewSet):
     lookup_field = "name"
 
     def get_queryset(self):
+        # If we are generating swagger definitions, return the correct
+        # queryset to allow types to be infered without error.
+        if getattr(self, "swagger_fake_view", False):
+            return models.Role.objects.none()
 
         # Add query to lookup roleholders by date.
         date_string = self.request.query_params.get("on_date", False)
@@ -97,6 +99,26 @@ def get_queryset(self):
         return queryset
 
 
+@drf_spectacular.utils.extend_schema_view(
+    list=drf_spectacular.utils.extend_schema(
+        parameters=[
+            drf_spectacular.utils.OpenApiParameter(
+                name="category_name",
+                type=str,
+                location=drf_spectacular.utils.OpenApiParameter.PATH,
+            ),
+        ],
+    ),
+    retrieve=drf_spectacular.utils.extend_schema(
+        parameters=[
+            drf_spectacular.utils.OpenApiParameter(
+                name="category_name",
+                type=str,
+                location=drf_spectacular.utils.OpenApiParameter.PATH,
+            ),
+        ]
+    ),
+)
 class ServicesNestedUnderCategoriesViewSet(ServicesViewSet):
     """Viewset to allow services to be nested under categories.
 
@@ -109,16 +131,39 @@ class ServicesNestedUnderCategoriesViewSet(ServicesViewSet):
 
     def get_queryset(self):
         queryset = super().get_queryset()
+
+        # If we are generating swagger definitions, return the correct
+        # queryset to allow types to be infered without error.
+        if getattr(self, "swagger_fake_view", False):
+            return queryset.none()
+
         return queryset.filter(category__name=self.kwargs["category_name"])
 
 
+@drf_spectacular.utils.extend_schema_view(
+    list=drf_spectacular.utils.extend_schema(
+        parameters=[
+            drf_spectacular.utils.OpenApiParameter(
+                name="user_username",
+                required=True,
+                type=str,
+                location=drf_spectacular.utils.OpenApiParameter.PATH,
+            )
+        ],
+    )
+)
 class UserServicesViewSet(rf_mixins.ListModelMixin, rf_viewsets.GenericViewSet):
     """Get the services assocated with a user."""
 
     required_scopes = ["jasmin.services.userservices.all"]
     serializer_class = serializers.ServiceListSerializer
 
     def get_queryset(self):
+        # If we are generating swagger definitions, return the correct
+        # queryset to allow types to be infered without error.
+        if getattr(self, "swagger_fake_view", False):
+            return models.Service.objects.none()
+
         return models.Service.objects.filter(
             role__access__user__username=self.kwargs["user_username"],
             role__access__grant__revoked=False,