Interface TagObject

Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.

See

https://spec.openapis.org/oas/latest.html#tag-object

interface TagObject {
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    name: string;
}

Hierarchy (view full)

Properties

description? externalDocs? name

Properties

Optional description

description?: string

A description for the tag. CommonMark syntax MAY be used for rich text representation.

Optional externalDocs

externalDocs?: ExternalDocumentationObject

Additional external documentation for this tag.

name

name: string

The name of the tag.

Settings

Member Visibility

Theme

On This Page

descriptionexternalDocsname