OpenAPI tag information.

It is possible to skip composing this structure, even if some tag names are registered in the API routes (OpenApi.IOperation.tags). In that case, the tag name would be displayed in Swagger-UI without description.

However, if you want to describe the tag name, you can compose this structure and describe the tag name in the description property.

interface ITag {
    description?: string;
    name: string;
}

Properties

Properties

description?: string

An optional string describing the tag.

name: string

The name of the tag.