Class: Grpc::Gateway::ProtocGenOpenapiv2::Options::Swagger

Inherits:

Object

Object
Grpc::Gateway::ProtocGenOpenapiv2::Options::Swagger

show all

Extended by:: Protobug::Message

Defined in:: lib/grpc/gateway/protoc_gen_openapiv2/options/openapiv2_pb.rb

Overview

‘Swagger` is a representation of OpenAPI v2 specification’s Swagger object.

See: 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: "none@example.com";
    };
    license: {
      name: "BSD 3-Clause License";
      url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
    };
  };
  schemes: HTTPS;
  consumes: "application/json";
  produces: "application/json";
};