Fix definition of vid_ranges in VLANGroup so it shows up in the OpenAPI schema
#18237
Conversation
This file contains 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
mraerino
changed the title
vid_ranges in VLANGroup so it shows up
mraerino
changed the title
vid_ranges in VLANGroup so it shows upvid_ranges in VLANGroup so it shows up in the OpenAPI schema
|
yeah i saw. i think this is likely a little bit more complex and i wanted to get this bug fix out quickly so people can use the API again. I can look into improving this in another PR, if you're ok with that? |
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: #17488
The OpenAPI schema for
vid_rangescannot automatically be discovered by drf-spectacular since it's a custom serializer with no fields. Therefore we need to manually provide the OpenAPI schema for the type we expect to see in requests and responses.On top of that there is a bug in drf-spectacular that required the workaround with the custom list class (tfranzel/drf-spectacular#1353).