...

Text file src/github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor/openapiconfig/openapiconfig.proto

Documentation: github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor/openapiconfig

     1syntax = "proto3";
     2
     3package grpc.gateway.internal.descriptor.openapiconfig;
     4
     5import "protoc-gen-openapiv2/options/openapiv2.proto";
     6
     7option go_package = "github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor/openapiconfig";
     8
     9// OpenAPIFileOption represents OpenAPI options on a file
    10message OpenAPIFileOption {
    11  string file = 1;
    12  grpc.gateway.protoc_gen_openapiv2.options.Swagger option = 2;
    13}
    14
    15// OpenAPIMethodOption represents OpenAPI options on a method
    16message OpenAPIMethodOption {
    17  string method = 1;
    18  grpc.gateway.protoc_gen_openapiv2.options.Operation option = 2;
    19}
    20
    21// OpenAPIMessageOption represents OpenAPI options on a message
    22message OpenAPIMessageOption {
    23  string message = 1;
    24  grpc.gateway.protoc_gen_openapiv2.options.Schema option = 2;
    25}
    26
    27// OpenAPIServiceOption represents OpenAPI options on a service
    28message OpenAPIServiceOption {
    29  string service = 1; // ex: Service
    30  grpc.gateway.protoc_gen_openapiv2.options.Tag option = 2;
    31}
    32
    33// OpenAPIFieldOption represents OpenAPI options on a field
    34message OpenAPIFieldOption {
    35  string field = 1;
    36  grpc.gateway.protoc_gen_openapiv2.options.JSONSchema option = 2;
    37}
    38
    39// OpenAPIOptions represents OpenAPI protobuf options
    40message OpenAPIOptions {
    41  repeated OpenAPIFileOption file = 1;
    42  repeated OpenAPIMethodOption method = 2;
    43  repeated OpenAPIMessageOption message = 3;
    44  repeated OpenAPIServiceOption service = 4;
    45  repeated OpenAPIFieldOption field = 5;
    46}
    47
    48// OpenAPIConfig represents a set of OpenAPI options
    49message OpenAPIConfig {
    50  OpenAPIOptions openapi_options = 1;
    51}

View as plain text