feat(enum): add support for enum varnames and descriptions#3310
Open
JoshThor wants to merge 1 commit intonestjs:masterfrom
Open
feat(enum): add support for enum varnames and descriptions#3310JoshThor wants to merge 1 commit intonestjs:masterfrom
JoshThor wants to merge 1 commit intonestjs:masterfrom
Conversation
Add support for enum varnames (x-enum-varnames) and description extensions (x-enum-descriptions).
benjGam
approved these changes
Feb 28, 2025
|
cool |
|
Any plans to get this merged? I would like to add descriptions to enum fields. |
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
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Currently only the
x-enumNamesextension is supported for specifying names for enums, however the popular openapi generator only supports thex-enum-varnamesextension.Issue Number: N/A
What is the new behavior?
Add support for the
x-enum-varnamesandx-enum-descriptionsextensions to be added to the schema.Example:
Would generate:
{ "StatusEnum ": { "type": "number", "enum": [ 1, 2, 3 ], "description": "The status enum example", "x-enum-varnames": [ "APPROVED", "PENDING", "REJECTED" ], "x-enum-descriptions": [ "Approved State", "Pending State", "Rejected State" ] } }Does this PR introduce a breaking change?
Other information