Class: Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation

Inherits:

Object

Object
Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation

show all

Extended by:: Protobug::Message

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

Overview

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

See: 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";
  }
  ...
};