api-morph / TagObject

Interface: TagObject

Defined in: src/types/openapi.ts:981

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/v3.1.1#tag-object

Indexable

[key: `x-${string}`]: any

This object MAY be extended with Specification Extensions.

Properties

description?

optional description: string

Defined in: src/types/openapi.ts:990

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

---

externalDocs?

optional externalDocs: ExternalDocumentationObject

Defined in: src/types/openapi.ts:995

Additional external documentation for this tag.

---

name

name: string

Defined in: src/types/openapi.ts:985

REQUIRED. The name of the tag.