Description option on @ApiTags decorator | NestJS | Page 1

sudden egret Mar 19, 2024, 7:59 AM

#

Hi all!
I want to add a description to a tag in swagger. The only way I can find is to add a tag to the Swagger DocumentBuilder object like this:

const builder = new DocumentBuilder();
builder.addTag('Health', 'Health check endpoints');

But as far as I can tell by the source code the @ApiTags('Health') only supports a spreaded array of tag strings as parameters, and no object or optional second parameters to provide an description.
It would be nice if the @ApiTags decorator functioned the same as the @ApiSecurity which allows a string as well as an option object for more customisable functionality.

Are there any plans to implement such feature?

calm marsh Mar 19, 2024, 9:07 AM

#

Is adding a description to tags part of the Open API standard?

sudden egret Mar 19, 2024, 9:53 AM

#

Yes. https://swagger.io/docs/specification/grouping-operations-with-tags/

calm marsh Mar 19, 2024, 10:28 AM

#

~~I'd suggest, you'd need to make an issue/ suggestion for improvement for this decorator method. ~~Edit: see below.

https://github.com/nestjs/swagger/blob/master/lib/decorators/api-use-tags.decorator.ts

And seeing all the issues and hanging PRs, I'd say, even if you made a PR, unfortunately it will be a while, before it becomes part of the library.

#

Actually, I just found this:
https://github.com/nestjs/swagger/issues/2404

So, your find is the way to add a description.

sudden egret Mar 19, 2024, 11:53 AM

#

Oh, right 🥲
Thanks for the help

#Description option on @ApiTags decorator