Skip to main content

Interface: $Properties

options.Tag.$Properties

Properties of a Tag.

Hierarchy​

  • $Properties

    ↳ ITag

Properties​

description​

• Optional description: null | string

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

extensions​

• Optional extensions: null | { [k: string]: $Properties; }

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: null | $Properties

Additional external documentation for this tag.

name​

• Optional name: null | string

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.