Skip to content

[I] TagMetadata

Metadata for a tag.

[extensionKey: string]: unknown

Additional extension data. Keys must start with x-.

PropertyTypeDescription
description?stringA description of the tag.
externalDocs?ExternalDocsExternal documentation for the tag.
kind?stringA machine-readable string to categorize what sort of tag it is. Only supported natively in OpenAPI 3.2. For 3.0 and 3.1, this will be emitted as x-oai-kind.
parent?stringThe name of a parent tag (only supported natively in OpenAPI 3.2; emitted as x-oai-parent for 3.0 and 3.1).
summary?stringA short summary of the tag, used for display purposes. Only supported natively in OpenAPI 3.2. For 3.0 and 3.1, this will be emitted as x-oai-summary.