Interface: ITag
protoc_gen_openapiv2.options.ITag
Properties of a Tag.
Implemented by
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]: IValue; }
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 | IExternalDocumentation
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.