Skip to content

Use X-User-Agent for Swagger API requests #2459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keshav-space merged 2 commits into from
Oct 2, 2026
Merged

Use X-User-Agent for Swagger API requests #2459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02720af
fix: use X-User-Agent for Swagger API requests
keshav-space Oct 1, 2026
f56a9f0
fix: use proper response type in swagger schema
keshav-space Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions vulnerabilities/api_v3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
3 changes: 2 additions & 1 deletion vulnerabilities/middleware/vcio_user_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": (
Expand Down
4 changes: 2 additions & 2 deletions vulnerabilities/templates/drf_spectacular/swagger_ui.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};

Expand Down
2 changes: 1 addition & 1 deletion vulnerablecode/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@
"defaultModelsExpandDepth": 1,
"displayRequestDuration": True,
"docExpansion": "list",
"userAgent": VCIO_USER_AGENT,
"xUserAgent": VCIO_USER_AGENT,
},
"AUTHENTICATION_WHITELIST": [
"rest_framework.authentication.TokenAuthentication",
Expand Down