New possibility to add enums with labels through oneof #928
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.
As discussed in this Stackoverflow thread there is no way to create enums with labels out of the box (like enums of integers for some configurations). The simplest workaround is to use a
oneOf
with constant values.As show below, displayed with rapidoc this leads in a very confusing documentation :
Openapi schema sample
Therefore I implemented a more suited way to display a one iff it contains only constant values :
Hope you find this convincing 😉