Document
| Name | Tag | Type | Label | Description |
|---|---|---|---|---|
info | 1 | Info | optional | Provides metadata about the API. The metadata MAY be used by tooling as required. |
servers | 2 | Server | repeated | An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /. |
external_docs | 3 | ExternalDocs | optional | Additional external documentation. |
tags | 4 | Tag | repeated | A list of tags used by the document with additional metadata. Tags
declared here are merged with the tags derived from proto services: an
entry here whose name matches a service's tag replaces the default,
and entries with new names are appended. This is the only way to
attach a description (or external docs) to a tag referenced by a
method-level |
extensions | 5 | map<string, google.protobuf.Value> | map | Custom specification extensions rendered at the root of the OpenAPI document. Keys MUST start with "x-". See: https://spec.openapis.org/oas/v3.1.0#specification-extensions |
components | 6 | Components | optional | Reusable objects rendered under the document's |
security | 7 | SecurityRequirement | repeated | A declaration of which security mechanisms can be used across the API.
The list of values includes alternative security requirement objects
that can be used. Only one of the security requirement objects needs to
be satisfied to authorize a request. Individual operations can override
this definition with |
Document is a file-level override applied to the top of the generated OpenAPI document. Only non-empty sub-fields replace the defaults the generator would otherwise synthesize from the proto file name.
Spec: https://spec.openapis.org/oas/v3.1.0#openapi-object