Add OpenAPI tags for inherited methods

In the past all of those were tagged as `api`, instead we are giving the correct tags according to its url path.
bitmakerla · Apr 21, 2023 · fd13959 · fd13959
1 parent 67cf664
commit fd13959
Show file tree

Hide file tree

Showing 18 changed files with 1,950 additions and 972 deletions.
diff --git a/estela-api/api/views/auth.py b/estela-api/api/views/auth.py
@@ -97,6 +97,9 @@ def register(self, request, *args, **kwargs):
         token, _ = Token.objects.get_or_create(user=user)
         return Response(TokenSerializer(token).data)
 
+    @swagger_auto_schema(
+        tags=["auth"],
+    )
     @action(methods=["GET"], detail=False)
     def activate(self, request, *args, **kwargs):
         token = request.query_params.get("token", "")
@@ -202,6 +205,35 @@ def update(self, request, *args, **kwargs):
         serializer.save()
         return Response(data=serializer.data, status=status.HTTP_200_OK)
 
+    @swagger_auto_schema(
+        tags=["auth", "profile"],
+    )
+    def list(self, request, *args, **kwargs):
+        return super().list(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_201_CREATED: UserProfileSerializer()},
+        tags=["auth", "profile"],
+    )
+    def create(self, request, *args, **kwargs):
+        return super().create(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: UserProfileSerializer()},
+        tags=["auth", "profile"],
+    )
+    def partial_update(self, request, *args, **kwargs):
+        return super().partial_update(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={
+            status.HTTP_204_NO_CONTENT: openapi.Response("No Content"),
+        },
+        tags=["auth", "profile"],
+    )
+    def destroy(self, request, *args, **kwargs):
+        return super().destroy(request, *args, **kwargs)
+
 
 class ChangePasswordViewSet(viewsets.GenericViewSet):
     @swagger_auto_schema(
@@ -252,6 +284,7 @@ def get_parameters(self, request):
         return token, user_id
 
     @swagger_auto_schema(
+        operation_id="api_account_resetPassword_request",
         methods=["POST"],
         responses={status.HTTP_200_OK: TokenSerializer()},
         tags=["account"],
@@ -260,8 +293,9 @@ def get_parameters(self, request):
         methods=["POST"],
         detail=False,
         serializer_class=ResetPasswordRequestSerializer,
+        url_path="request",
     )
-    def request(self, request, *args, **kwargs):
+    def request_reset(self, request, *args, **kwargs):
         serializer = ResetPasswordRequestSerializer(data=request.data)
         serializer.is_valid(raise_exception=True)
         email = serializer.validated_data["email"]

diff --git a/estela-api/api/views/cronjob.py b/estela-api/api/views/cronjob.py
@@ -148,3 +148,17 @@ def run_once(self, request, *args, **kwargs):
 
         run_cronjob_once(cronjob.data)
         return Response(cronjob.data, status=status.HTTP_200_OK)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: SpiderCronJobSerializer()},
+        tags=["project", "spider", "cronjob"],
+    )
+    def retrieve(self, request, *args, **kwargs):
+        return super().retrieve(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: SpiderCronJobSerializer()},
+        tags=["project", "spider", "cronjob"],
+    )
+    def partial_update(self, request, *args, **kwargs):
+        return super().partial_update(request, *args, **kwargs)
diff --git a/estela-api/api/views/deploy.py b/estela-api/api/views/deploy.py
@@ -1,4 +1,5 @@
 from django.shortcuts import get_object_or_404
+from drf_yasg import openapi
 from drf_yasg.utils import swagger_auto_schema
 from rest_framework import viewsets, status
 from rest_framework.response import Response
@@ -95,3 +96,32 @@ def update(self, request, *args, **kwargs):
 
         headers = self.get_success_headers(serializer.data)
         return Response(serializer.data, status=status.HTTP_200_OK, headers=headers)
+
+    @swagger_auto_schema(
+        tags=["project", "deploy"],
+    )
+    def list(self, request, *args, **kwargs):
+        return super().list(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: DeploySerializer()},
+        tags=["project", "deploy"],
+    )
+    def retrieve(self, request, *args, **kwargs):
+        return super().retrieve(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: DeploySerializer()},
+        tags=["project", "deploy"],
+    )
+    def partial_update(self, request, *args, **kwargs):
+        return super().partial_update(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={
+            status.HTTP_204_NO_CONTENT: openapi.Response("No Content"),
+        },
+        tags=["project", "deploy"],
+    )
+    def destroy(self, request, *args, **kwargs):
+        return super().destroy(request, *args, **kwargs)
diff --git a/estela-api/api/views/job.py b/estela-api/api/views/job.py
@@ -1,4 +1,3 @@
-from datetime import date, timedelta
 from django.shortcuts import get_object_or_404
 from django_filters.rest_framework import DjangoFilterBackend
 from drf_yasg.utils import swagger_auto_schema
@@ -164,3 +163,17 @@ def update(self, request, *args, **kwargs):
 
         headers = self.get_success_headers(serializer.data)
         return Response(serializer.data, status=status.HTTP_200_OK, headers=headers)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: SpiderJobSerializer()},
+        tags=["project", "spider", "job"],
+    )
+    def retrieve(self, request, *args, **kwargs):
+        return super().retrieve(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: SpiderJobSerializer()},
+        tags=["project", "spider", "job"],
+    )
+    def partial_update(self, request, *args, **kwargs):
+        return super().partial_update(request, *args, **kwargs)
diff --git a/estela-api/api/views/project.py b/estela-api/api/views/project.py
@@ -282,3 +282,30 @@ def usage(self, request, *args, **kwargs):
             serializer.data,
             status=status.HTTP_200_OK,
         )
+
+    @swagger_auto_schema(
+        tags=["project"],
+    )
+    def list(self, request, *args, **kwargs):
+        return super().list(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: ProjectSerializer()},
+        tags=["project"],
+    )
+    def retrieve(self, request, *args, **kwargs):
+        return super().retrieve(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_201_CREATED: ProjectSerializer()},
+        tags=["project"],
+    )
+    def create(self, request, *args, **kwargs):
+        return super().create(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: ProjectSerializer()},
+        tags=["project"],
+    )
+    def partial_update(self, request, *args, **kwargs):
+        return super().partial_update(request, *args, **kwargs)
diff --git a/estela-api/api/views/spider.py b/estela-api/api/views/spider.py
@@ -41,3 +41,23 @@ def update(self, request, *args, **kwargs):
             instance._prefetched_objects_cache = {}
 
         return Response(serializer.data, status=status.HTTP_200_OK)
+
+    @swagger_auto_schema(
+        tags=["project", "spider"],
+    )
+    def list(self, request, *args, **kwargs):
+        return super().list(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: SpiderSerializer()},
+        tags=["project", "spider"],
+    )
+    def retrieve(self, request, *args, **kwargs):
+        return super().retrieve(request, *args, **kwargs)
+
+    @swagger_auto_schema(
+        responses={status.HTTP_200_OK: SpiderSerializer()},
+        tags=["project", "spider"],
+    )
+    def partial_update(self, request, *args, **kwargs):
+        return super().partial_update(request, *args, **kwargs)