nestjs / swagger

OpenAPI (Swagger) module for Nest framework (node.js) :earth_americas:

Home Page:https://nestjs.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Parse @param from JSDoc (again)

thw0rted opened this issue · comments

Is there an existing issue that is already proposing this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe it

I don't see any way to populate the description of a @Query or @Param argument to a controller method using existing JSDoc / TSDoc tags.

Describe the solution you'd like

If the JSDoc comment for a controller method includes an @param tag matching the variable with the @Query or @Param decorator, the CLI plugin should generate the corresponding @APIQuery or @APIParam decorator.

Teachability, documentation, adoption, migration strategy

No response

What is the motivation / use case for changing the behavior?

Already requested in #1695 , which was closed after https://github.com/nestjs/swagger/pull/1720/files was merged, but that added parsing for @deprecated, not @param.