Package grpc.gateway.protoc_gen_openapiv2.options

`Swagger` is a representation of OpenAPI v2 specification's Swagger object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject
Example:
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "Echo API";
     version: "1.0";
     description: ";
     contact: {
       name: "gRPC-Gateway project";
       url: "https://github.com/grpc-ecosystem/grpc-gateway";
       email: "[email protected]";
     };
     license: {
       name: "BSD 3-Clause License";
       url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
     };
   };
   schemes: HTTPS;
   consumes: "application/json";
   produces: "application/json";
 };

`Operation` is a representation of OpenAPI v2 specification's Operation object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject
Example:
 service EchoService {
   rpc Echo(SimpleMessage) returns (SimpleMessage) {
     option (google.api.http) = {
       get: "/v1/example/echo/{id}"
     };
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       summary: "Get a message.";
       operation_id: "getMessage";
       tags: "echo";
       responses: {
         key: "200"
           value: {
           description: "OK";
         }
       }
     };
   }
 }

`Header` is a representation of OpenAPI v2 specification's Header object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject

`Response` is a representation of OpenAPI v2 specification's Response object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject

`Info` is a representation of OpenAPI v2 specification's Info object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject
Example:
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "Echo API";
     version: "1.0";
     description: ";
     contact: {
       name: "gRPC-Gateway project";
       url: "https://github.com/grpc-ecosystem/grpc-gateway";
       email: "[email protected]";
     };
     license: {
       name: "BSD 3-Clause License";
       url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
     };
   };
   ...
 };

`Contact` is a representation of OpenAPI v2 specification's Contact object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject
Example:
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     ...
     contact: {
       name: "gRPC-Gateway project";
       url: "https://github.com/grpc-ecosystem/grpc-gateway";
       email: "[email protected]";
     };
     ...
   };
   ...
 };

`License` is a representation of OpenAPI v2 specification's License object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject
Example:
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     ...
     license: {
       name: "BSD 3-Clause License";
       url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
     };
     ...
   };
   ...
 };

`ExternalDocumentation` is a representation of OpenAPI v2 specification's
ExternalDocumentation object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject
Example:
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   ...
   external_docs: {
     description: "More about gRPC-Gateway";
     url: "https://github.com/grpc-ecosystem/grpc-gateway";
   }
   ...
 };

`Schema` is a representation of OpenAPI v2 specification's Schema object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject

`JSONSchema` represents properties from JSON Schema taken, and as used, in
the OpenAPI v2 spec.
This includes changes made by OpenAPI v2.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
See also: https://cswr.github.io/JsonSchema/spec/basic_types/,
https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json
Example:
 message SimpleMessage {
   option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
     json_schema: {
       title: "SimpleMessage"
       description: "A simple message."
       required: ["id"]
     }
   };
   // Id represents the message identifier.
   string id = 1; [
       (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
         description: "The unique identifier of the simple message."
       }];
 }

`Tag` is a representation of OpenAPI v2 specification's Tag object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject

`SecurityDefinitions` is a representation of OpenAPI v2 specification's
Security Definitions object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject
A declaration of the security schemes available to be used in the
specification. This does not enforce the security schemes on the operations
and only serves to provide the relevant details for each scheme.

`SecurityScheme` is a representation of OpenAPI v2 specification's
Security Scheme object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject
Allows the definition of a security scheme that can be used by the
operations. Supported schemes are basic authentication, an API key (either as
a header or as a query parameter) and OAuth2's common flows (implicit,
password, application and access code).

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.

`SecurityRequirement` is a representation of OpenAPI v2 specification's
Security Requirement object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject
Lists the required security schemes to execute this operation. The object can
have multiple security schemes declared in it which are all required (that
is, there is a logical AND between the schemes).
The name used for each property MUST correspond to a security scheme
declared in the Security Definitions.

`Scopes` is a representation of OpenAPI v2 specification's Scopes object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject
Lists the available scopes for an OAuth2 security scheme.

Scheme describes the schemes supported by the OpenAPI Swagger
and Operation objects.

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

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