[I] TagMetadata
Metadata for a tag.
Extended by
Section titled “Extended by”Indexable
Section titled “Indexable”[extensionKey: string]: unknownAdditional extension data. Keys must start with x-.
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
description? | string | A description of the tag. |
externalDocs? | ExternalDocs | External documentation for the tag. |
kind? | string | A 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? | string | The name of a parent tag (only supported natively in OpenAPI 3.2; emitted as x-oai-parent for 3.0 and 3.1). |
summary? | string | A 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. |