Merge pull request #2459 from aboutcode-org/2456-fix-swagger

Use X-User-Agent for Swagger API requests

Author: keshav-space

vulnerabilities/api_v3.py

@@ -275,7 +275,11 @@ class PackageV3ViewSet(viewsets.GenericViewSet):
     filter_backends = [filters.DjangoFilterBackend]
     throttle_classes = [AnonRateThrottle, PermissionBasedUserRateThrottle]
 
-    @extend_schema(request=PackageQuerySerializer)
+    @extend_schema(
+        operation_id="v3_packages_retrieve",
+        request=PackageQuerySerializer,
+        responses={200: PackageV3Serializer(many=True)},
+    )
     def create(self, request, *args, **kwargs):
         serializer = PackageQuerySerializer(data=request.data)
         serializer.is_valid(raise_exception=True)
@@ -411,7 +415,11 @@ class AdvisoryV3ViewSet(viewsets.GenericViewSet):
     filter_backends = [filters.DjangoFilterBackend]
     throttle_classes = [AnonRateThrottle, PermissionBasedUserRateThrottle]
 
-    @extend_schema(request=AdvisoryQuerySerializer)
+    @extend_schema(
+        operation_id="v3_advisories_retrieve",
+        request=AdvisoryQuerySerializer,
+        responses={200: AdvisoryV3Serializer(many=True)},
+    )
     def create(self, request, *args, **kwargs):
         serializer = AdvisoryQuerySerializer(data=request.data)
         serializer.is_valid(raise_exception=True)

vulnerabilities/middleware/vcio_user_agent.py

@@ -24,8 +24,9 @@ def __call__(self, request):
             ("/api/docs/", "/api/schema/")
         ):
             user_agent = request.headers.get("User-Agent", "")
+            x_user_agent = request.headers.get("X-User-Agent", "")
             docs_url = request.build_absolute_uri("/api/docs/")
-            if user_agent != settings.VCIO_USER_AGENT:
+            if settings.VCIO_USER_AGENT not in [user_agent, x_user_agent]:
                 return JsonResponse(
                     {
                         "detail": (

vulnerabilities/templates/drf_spectacular/swagger_ui.html

@@ -33,8 +33,8 @@
         swaggerSettings.dom_id = "#swagger-ui";
 
         swaggerSettings.requestInterceptor = (request) => {
-            const userAgent = swaggerSettings.userAgent || "VCIO_API_AGENT";
-            request.headers['User-Agent'] = userAgent;
+            const xUserAgent = swaggerSettings.xUserAgent || "VCIO_API_AGENT";
+            request.headers['X-User-Agent'] = xUserAgent;
             return request;
         };
 

vulnerablecode/settings.py

@@ -339,7 +339,7 @@
         "defaultModelsExpandDepth": 1,
         "displayRequestDuration": True,
         "docExpansion": "list",
-        "userAgent": VCIO_USER_AGENT,
+        "xUserAgent": VCIO_USER_AGENT,
     },
     "AUTHENTICATION_WHITELIST": [
         "rest_framework.authentication.TokenAuthentication",