fix: enumName
is ignored in @Api[Param|Query|Header]
#2734
Merged
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:
=> Documentation is already describing the correct expected behavior: https://docs.nestjs.com/openapi/types-and-parameters#enums-schema:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Using
enumName
in@Api[Param|Query|Header]
is not making a reference to the enum model in the Openapi specification.=>
When removing
@Param('type') type: LettersEnum
, the enum is correctly referenced:The expected behavior should be like this last screen in both cases (with or without a param in the method).
What is the new behavior?
In
SchemaObjectFactory.createFromModel
, when we get a primitive type infered from method parameter metadata, it skips the call ofcreateEnumParam
which handles enums references via$ref
.Calling it before
isPrimitiveType
did the job.BTW, I also improved the implementation of
ApiParam
to make it look like more likeApiQuery
by usingaddEnumSchema
Does this PR introduce a breaking change?
Other information