Interface: IExternalDocumentation

protoc_gen_openapiv2.options.IExternalDocumentation

Properties of an ExternalDocumentation.

Implemented by

• ExternalDocumentation

Properties

description

• Optional description: null | string

A short description of the target documentation. GFM syntax can be used for rich text representation.

---

url

• Optional url: null | string

The URL for the target documentation. Value MUST be in the format of a URL.