fix(plugin): ensure open-api docs generation for types named with Promise or Observable #2869
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?
I've encountered an issue with NestJS Swagger where automatic API documentation generation does not properly handle types that include the
Promise
orObservable
keywords. This occurs when using@Body()
,@Query()
, or return types in controllers that are intended to be documented by Swagger.Issue Number: N/A
What is the new behavior?
Types that include
Promise
orObservable
should be accurately reflected in the Swagger documentation.Does this PR introduce a breaking change?
Other information