darraghoriordan / eslint-plugin-nestjs-typed

Some eslint rules for working with NestJs projects
http://www.darraghoriordan.com
171 stars 34 forks source link

Swagger: Rule for requiring @ApiParam and @ApiQuery for every @Param() and @Query() used. #117

Closed RoboPhred closed 10 months ago

RoboPhred commented 10 months ago

We would like to enforce well-defined swagger docs for all queries and params. It would be great if any presence of a @Param() or @Query() decorator on an argument could enforce a @ApiParam or @ApiQuery on the model itself.

Chances are good I will be submitting a PR for this myself. We are currently in the trial phases of checking out nestjs and this is a big sticking point to us. It might be a while before I can get to it though, so I wanted to bring this up early to check out if its something that this library would be interested in having.