Configure drf-spectacular schema to more closely match drf-yasg #1670
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
bryanculver
approved these changes
Apr 20, 2022
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.
Relates-to: nautobot/nautobot-ansible#135
What's Changed
Although the OpenAPI 3.0 schema is fundamentally different in its structure from OpenAPI 2.0, we can configure drf-spectacular to make it match a bit more closely in the parts that can be treated similarly. Specifically it turns out that nautobot-ansible was introspecting the schema to identify the set of valid query parameters that can be used in filtering the device/VM inventory, and our schema was just different enough to break that introspection. This set of config changes should reduce the impact to that library.
I verified that the Swagger UI still works correctly after this change.
Nautobot 1.2:
Nautobot 1.3.1:
(note leading
/apion paths)After this changeset: