Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(plugin): ensure open-api docs generation for types named with Promise or Observable #2869

Conversation

jinyongp
Copy link
Contributor

@jinyongp jinyongp commented Mar 9, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

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 or Observable 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 or Observable should be accurately reflected in the Swagger documentation.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@kamilmysliwiec kamilmysliwiec merged commit 91a40a3 into nestjs:master Jul 1, 2024
1 check passed
@kamilmysliwiec
Copy link
Member

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants