Add support for x-enumDescriptions extension #1359
Open
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1359 +/- ##
==========================================
+ Coverage 98.42% 98.57% +0.15%
==========================================
Files 74 74
Lines 9139 9146 +7
==========================================
+ Hits 8995 9016 +21
+ Misses 144 130 -14 ☔ View full report in Codecov by Sentry. |
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 adds support for the
x-enumDescriptionsOpenAPI extension field as documented here:https://redocly.com/docs/realm/author/reference/openapi-extensions/x-enum-descriptions
Redoc and Scalar support this extension and provide a better UX than text-based descriptions.
The change is fully backward-compatible. I added a new boolean setting
ENUM_GENERATE_X_ENUM_DESCRIPTIONSto enable this feature. Let me know if this makes sense for you.