Replace OpenAPI usage of enum in favor of x-extensible-enum #967
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
This commit introduces a postprocessing hook for drf-spectacular which will convert all enums used in the OSIDB API into x-extensible-enums. This is a proprietary extension pushed by the Zalando API Guidelines which essentially tells clients that a given enumeration may grow in the future and that said growth does not constitute a breaking change, so clients should be ready to accept any value. For clients not recognizing the x-extensible-enum extension, the type should become looser (string), so this shouldn't be considered a breaking change either.
Elkasitu
added
the
technical
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.
This commit introduces a postprocessing hook for drf-spectacular which will convert all enums used in the OSIDB API into x-extensible-enums.
This is a proprietary extension pushed by the Zalando API Guidelines which essentially tells clients that a given enumeration may grow in the future and that said growth does not constitute a breaking change, so clients should be ready to accept any value.
For clients not recognizing the x-extensible-enum extension, the type should become looser (string), so this shouldn't be considered a breaking change either.