Fixes #20638: Document bulk create support in OpenAPI schema #20777
+3,158
−502
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
POST operations on NetBoxModelViewSet endpoints accept both single objects and arrays, but the schema only documented single objects. This prevented API client generators from producing correct code. Add explicit bulk_create_enabled flag to NetBoxModelViewSet and update schema generation to emit oneOf for these endpoints.
jnovinger
requested review from
a team and
arthanson
and removed request for
a team
jeremystretch
requested review from
jeremystretch
and removed request for
arthanson
|
|
||
| # Declare that this viewset accepts either single objects or arrays for creation | ||
| # Refs: #20638 | ||
| bulk_create_enabled = True |
Member
There was a problem hiding this comment.
IMO we shouldn't rely on an explicit declaration of functionality as this can be unreliable. Rather, we should infer bulk creation ability from the existence of some inherent indicator. For instance, we could detect bulk update support by the existence of a bulk_update() method.
We might be able to achieve this by declaring a separate bulk_create() method and extending NetBoxRouter to route to it for POST operations on the list view. I suspect this would simplify some of the logic under NetBoxAutoSchema as well.
|
|
||
| return response_serializers | ||
|
|
||
| def _get_request_for_media_type(self, serializer, direction): |
Member
There was a problem hiding this comment.
To preserve the default
Suggested change
| def _get_request_for_media_type(self, serializer, direction): | |
| def _get_request_for_media_type(self, serializer, direction='request'): |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #20638
POST operations on
NetBoxModelViewSetendpoints accept both single objects and arrays, but the schema only documented single objects. This prevented REST API client generators from producing correct code.Add explicit bulk_create_enabled flag to
NetBoxModelViewSetand update schema generation to emitoneOffor these endpoints.FWIW, I don't believe the
PUTissue reported is a bug. The schema seems to correctly documentPUTas array-only. NetBox's PUT is a bulk operation by design. For single updates, usePATCH /api/model/{id}/.