Fixes #20365: Fix schema and field definitions for OpenAPI #20407
Conversation
jnovinger
requested review from
a team,
bctiemann and
jeremystretch
and removed request for
a team and
jeremystretch
jeremystretch
requested review from
jeremystretch
and removed request for
bctiemann
netbox/core/api/views.py
Outdated
|
|
||
|
|
||
| class BaseRQViewSet(viewsets.ViewSet): | ||
| class BaseRQViewSet(viewsets.GenericViewSet): |
There was a problem hiding this comment.
I'm not sure it makes sense to employ GenericViewSet here as it adds methods such as get_queryset() which aren't applicable, as the view doesn't use a model. Could we instead just add declare a get_serializer_class() method?
There was a problem hiding this comment.
Thanks for the thoughtful review!
You’re absolutely right.
My initial pass was to add get_serializer_class(), but the custom get_serializer() also expects get_serializer_context(). To avoid re‑implementing both, I tried GenericViewSet as a shortcut, though I agree it broadens the API surface unnecessarily.
I’ll revert the base class to viewsets.ViewSet and add minimal helpers for the serializer class/context locally.
Thanks again for the guidance!
netbox/core/api/views.py
Outdated
| @extend_schema(responses={200: OpenApiTypes.OBJECT}) | ||
| @extend_schema( | ||
| operation_id='core_background_tasks_retrieve_by_id', | ||
| parameters=[OpenApiParameter(name='pk', type=OpenApiTypes.STR, location=OpenApiParameter.PATH)], |
There was a problem hiding this comment.
Is this redundant to line 192 above? (Also, here we call the parameter pk but above it's named id.)
There was a problem hiding this comment.
Thanks for catching that!
You’re right on both points: the second annotation is redundant with line 192, and the parameter name mismatch (pk vs id) is my oversight. I’ll remove the duplicate, and standardize on id across the view methods (and the serializer’s HyperlinkedIdentityField) to match the route kwarg and keep the OpenAPI output consistent.
Appreciate the careful review!
Add `get_internal_type()` to custom field classes for Django compatibility, annotate path parameters and operation IDs for background endpoints, and provide serializer context on the RQ base viewset to clear schema warnings. Fixes netbox-community#20365
pheus
force-pushed
the
20365-fix-openapi-schema-generation-warnings-and-errors
branch
from
ae274a8 to
ff29107
Compare
pheus
deleted the
20365-fix-openapi-schema-generation-warnings-and-errors
branch
2 participants
Fixes: #20365
get_internal_type()on custom fields for Django introspection.id/namepath params and add explicitoperation_ids for queues/workers/tasksget_serializer_class()andget_serializer_context()on the RQ base viewset