Skip to main content

Interface: $Properties

Properties of a Tag.

Extended by​

Properties​

description?​

optional description?: string | null

A short description for the tag. GFM syntax can be used for rich text representation.

extensions?​

optional extensions?: {[k: string]: $Properties; } | null

Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

externalDocs?​

optional externalDocs?: $Properties | null

Additional external documentation for this tag.

name?​

optional name?: string | null

The name of the tag. Use it to allow override of the name of a global Tag object, then use that name to reference the tag throughout the OpenAPI file.