Interface OpenApiTag

A tag entry in the OpenAPI top-level tags array. Provides a name, optional description, and optional external documentation for a tag group.

interface OpenApiTag {
    description?: string;
    externalDocs?: { description?: string; url: string };
    name: string;
}

Properties

description?: string

Short description for the tag group, displayed in Swagger UI / Redoc.

externalDocs?: { description?: string; url: string }

Link to external documentation for this tag.

name: string

Tag name. Must match the tag strings used on individual operations.