grpc.gateway.protoc_gen_openapiv2.options

Specifies the OpenAPI Specification version being used. It can be used by the OpenAPI UI and other clients to interpret the API listing. The value MUST be "2.0".

Provides metadata about the API. The metadata can be used by the clients if needed.

The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.

The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. Note that using base_path does not change the endpoint paths that are generated in the resulting OpenAPI file. If you wish to use base_path with relatively generated OpenAPI paths, the base_path prefix must be manually removed from your google.api.http paths and your code changed to serve the API from the base_path.

The transfer protocol of the API. Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.

A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.

A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.

An object to hold responses that can be used across operations. This property does not define global responses for all operations.

Security scheme definitions that can be used across the specification.

A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

Additional external documentation.

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/

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.

A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.

Additional external documentation for this operation.

Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.

A list of MIME types the operation can consume. This overrides the consumes definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.

A list of MIME types the operation can produce. This overrides the produces definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.

The list of possible responses as they are returned from executing this operation.

The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the OpenAPI Object schemes definition.

Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.

A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.

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/

Custom parameters such as HTTP request headers. See: https://swagger.io/docs/specification/2-0/describing-parameters/ and https://swagger.io/specification/v2/#parameter-object.

Headers is one or more HTTP header parameter. See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters

Name is the header name.

Description is a short description of the header.

Type is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported. See: https://swagger.io/specification/v2/#parameterType.

Format The extending format for the previously mentioned type.

Required indicates if the header is optional

Description is a short description of the header.

The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.

Format The extending format for the previously mentioned type.

Default Declares the value of the header that the server will use if none is provided. See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.

'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.

Description is a short description of the response. GFM syntax can be used for rich text representation.

Schema optionally defines the structure of the response. If Schema is not provided, it means there is no content to the response.

Headers A list of headers that are sent with the response. Header name is expected to be a string in the canonical format of the MIME header key See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey

Examples gives per-mimetype response examples. See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object

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/

The title of the application.

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

The Terms of Service for the API.

The contact information for the exposed API.

The license information for the exposed API.

Provides the version of the application API (not to be confused with the specification version).

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/

The identifying name of the contact person/organization.

The URL pointing to the contact information. MUST be in the format of a URL.

The email address of the contact person/organization. MUST be in the format of an email address.

The license name used for the API.

A URL to the license used for the API. MUST be in the format of a URL.

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

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

Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it.

Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false.

Additional external documentation for this schema.

A free-form property to include an example of an instance for this schema in JSON. This is copied verbatim to the output.

A short description of the schema.

The title of the schema.

Additional external documentation for this schema.

Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference, and that type must be imported into the protofile. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp".

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/

Ref is used to define an external reference to include in the message. This could be a fully qualified proto message reference, and that type must be imported into the protofile. If no message is identified, the Ref will be used verbatim in the output. For example: ref: ".google.protobuf.Timestamp".

The title of the schema.

A short description of the schema.

A free-form property to include a JSON example of this field. This is copied verbatim to the output swagger.json. Quotes must be escaped. This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject

Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,

minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,

Items in 'array' must be unique.

Format

Items in enum must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1

Additional field level properties used when generating the OpenAPI v2 file.

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/

Alternative parameter name when used as path parameter. If set, this will be used as the complete parameter name when this field is used as a path parameter. Use this to avoid having auto generated path parameter names for overlapping paths.

Declares this field to be deprecated. Allows for the generated OpenAPI parameter to be marked as deprecated without affecting the proto field.

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.

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

Additional external documentation for this tag.

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/

A single security scheme definition, mapping a "name" to the scheme it defines.

The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".

A short description for security scheme.

The name of the header or query parameter to be used. Valid for apiKey.

The location of the API key. Valid values are "query" or "header". Valid for apiKey.

The flow used by the OAuth2 security scheme. Valid values are "implicit", "password", "application" or "accessCode". Valid for oauth2.

The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Valid for oauth2/implicit and oauth2/accessCode.

The token URL to be used for this flow. This SHOULD be in the form of a URL. Valid for oauth2/password, oauth2/application and oauth2/accessCode.

The available scopes for the OAuth2 security scheme. Valid for oauth2.

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/

Each name must correspond to a security scheme which is declared in the Security Definitions. If the security scheme is of type "oauth2", then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.

Maps between a name of a scope to a short description of it (as the value of the property).