chore: remove swagger warnings (SecObserve#4207)

Author: StefanFl

backend/application/core/api/views_others.py

@@ -34,6 +34,7 @@ class PURLTypeOneView(APIView):
         methods=["GET"],
         request=None,
         responses={HTTP_200_OK: PURLTypeSerializer},
+        operation_id="purl_types_retrieve",
     )
     @action(detail=True, methods=["get"])
     def get(self, request: Request, purl_type_id: str) -> Response:
@@ -53,6 +54,7 @@ class PURLTypeManyView(APIView):
         methods=["GET"],
         request=None,
         responses={HTTP_200_OK: PURLTypeSerializer},
+        operation_id="purl_types_list",
     )
     @action(detail=False, methods=["get"])
     def get(self, request: Request) -> Response:

backend/application/core/api/views_product.py

@@ -516,6 +516,9 @@ def create(self, request: Request) -> Response:
         return response
 
     @extend_schema(
+        parameters=[
+            OpenApiParameter(name="id", location=OpenApiParameter.PATH, required=True, type=int),
+        ],
         responses={HTTP_204_NO_CONTENT: None},
     )
     def destroy(self, request: Request, pk: int) -> Response:

backend/application/import_observations/api/views.py

@@ -403,6 +403,7 @@ class ScanOSVProductView(APIView):
     @extend_schema(
         request=None,
         responses={status.HTTP_200_OK: APIImportObservationsResponseSerializer},
+        operation_id="products_scan_osv_create",
     )
     @action(detail=True, methods=["post"])
     def post(self, request: Request, product_id: int) -> Response:
@@ -428,6 +429,7 @@ class ScanOSVBranchView(APIView):
     @extend_schema(
         request=None,
         responses={status.HTTP_200_OK: APIImportObservationsResponseSerializer},
+        operation_id="products_branch_scan_osv_create",
     )
     @action(detail=True, methods=["post"])
     def post(self, request: Request, product_id: int, branch_id: int) -> Response:

backend/application/metrics/api/serializers.py

@@ -0,0 +1,24 @@
+from rest_framework.serializers import DateTimeField, IntegerField, Serializer
+
+
+class ProductMetricsSerializer(Serializer):
+    active_critical = IntegerField()
+    active_high = IntegerField()
+    active_medium = IntegerField()
+    active_low = IntegerField()
+    active_none = IntegerField()
+    active_unknown = IntegerField()
+    open = IntegerField()
+    affected = IntegerField()
+    resolved = IntegerField()
+    duplicate = IntegerField()
+    false_positive = IntegerField()
+    in_review = IntegerField()
+    not_affected = IntegerField()
+    not_security = IntegerField()
+    risk_accepted = IntegerField()
+
+
+class ProductMetricsStatusSerializer(Serializer):
+    last_calculated = DateTimeField()
+    calculation_interval = IntegerField()

backend/application/metrics/api/views.py

@@ -3,10 +3,13 @@
 from typing import Optional
 
 from django.http import HttpResponse
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema
 from rest_framework.decorators import action
 from rest_framework.exceptions import ValidationError
 from rest_framework.request import Request
 from rest_framework.response import Response
+from rest_framework.status import HTTP_200_OK
 from rest_framework.views import APIView
 
 from application.authorization.services.authorization import user_has_permission_or_403
@@ -15,6 +18,10 @@
 from application.core.models import Product
 from application.core.queries.product import get_product_by_id
 from application.core.types import Severity
+from application.metrics.api.serializers import (
+    ProductMetricsSerializer,
+    ProductMetricsStatusSerializer,
+)
 from application.metrics.models import Product_Metrics_Status
 from application.metrics.services.export_metrics import (
     export_product_metrics_csv,
@@ -28,6 +35,11 @@
 
 
 class ProductMetricsTimelineView(APIView):
+    @extend_schema(
+        methods=["GET"],
+        request=None,
+        responses={HTTP_200_OK: dict},
+    )
     @action(detail=False, methods=["get"])
     def get(self, request: Request) -> Response:
         product = _get_and_check_product(request)
@@ -36,13 +48,25 @@ def get(self, request: Request) -> Response:
 
 
 class ProductMetricsCurrentView(APIView):
+    @extend_schema(
+        methods=["GET"],
+        request=None,
+        responses={HTTP_200_OK: ProductMetricsSerializer},
+    )
     @action(detail=False, methods=["get"])
     def get(self, request: Request) -> Response:
         product = _get_and_check_product(request)
         return Response(get_product_metrics_current(product))
 
 
 class ProductMetricsExportExcelView(APIView):
+    @extend_schema(
+        methods=["GET"],
+        request=None,
+        responses={
+            (HTTP_200_OK, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"): OpenApiTypes.BINARY
+        },
+    )
     @action(detail=False, methods=["get"])
     def get(self, request: Request) -> HttpResponse:
         product = _get_and_check_product(request)
@@ -65,6 +89,11 @@ def get(self, request: Request) -> HttpResponse:
 
 
 class ProductMetricsExportCsvView(APIView):
+    @extend_schema(
+        methods=["GET"],
+        request=None,
+        responses={(HTTP_200_OK, "text/csv"): OpenApiTypes.BINARY},
+    )
     @action(detail=False, methods=["get"])
     def get(self, request: Request) -> HttpResponse:
         product = _get_and_check_product(request)
@@ -78,6 +107,11 @@ def get(self, request: Request) -> HttpResponse:
 
 
 class ProductMetricsExportCodeChartaView(APIView):
+    @extend_schema(
+        methods=["GET"],
+        request=None,
+        responses={(HTTP_200_OK, "text/csv"): OpenApiTypes.BINARY},
+    )
     @action(detail=False, methods=["get"])
     def get(self, request: Request) -> HttpResponse:
         product = _get_and_check_product(request)
@@ -111,6 +145,11 @@ def get(self, request: Request) -> HttpResponse:
 
 
 class ProductMetricsStatusView(APIView):
+    @extend_schema(
+        methods=["GET"],
+        request=None,
+        responses={HTTP_200_OK: ProductMetricsStatusSerializer},
+    )
     @action(detail=False, methods=["get"])
     def get(self, request: Request) -> Response:
         settings = Settings.load()

backend/config/settings/base.py

@@ -414,6 +414,19 @@ def whitenoise_security_headers(headers: dict, path: str, url: str) -> None:
     "REDOC_DIST": "SIDECAR",
     "SWAGGER_UI_SETTINGS": {"docExpansion": "none"},
     "ENUM_GENERATE_CHOICE_DESCRIPTION": False,
+    "ENUM_NAME_OVERRIDES": {
+        "ApprovalStatusEnum": "application.core.types.Assessment_Status.ASSESSMENT_STATUS_CHOICES_APPROVAL",
+        "AssessmentStatusEnum": "application.core.types.Assessment_Status.ASSESSMENT_STATUS_CHOICES",
+        "NotificationTypeEnum": "application.notifications.models.Notification.TYPE_CHOICES",
+        "ParserTypeEnum": "application.import_observations.types.Parser_Type.TYPE_CHOICES",
+        "PotentialDuplicateTypeEnum": "application.core.models.Potential_Duplicate.POTENTIAL_DUPLICATE_TYPES",
+        "RuleStatusEnum": "application.rules.types.Rule_Status.RULE_STATUS_CHOICES",
+        "RuleTypeEnum": "application.rules.types.Rule_Type.RULE_TYPE_CHOICES",
+        "SeverityEnum": "application.core.types.Severity.SEVERITY_CHOICES",
+        "Status82cEnum": "application.core.types.Status.STATUS_CHOICES",
+        "VexDocumentTypeEnum": "application.vex.types.VEX_Document_Type.VEX_DOCUMENT_TYPE_CHOICES",
+        "VexJustificationEnum": "application.core.types.VEX_Justification.VEX_JUSTIFICATION_CHOICES",
+    },
 }
 
 FIELD_ENCRYPTION_KEY = env("FIELD_ENCRYPTION_KEY")