github.com/grpc-ecosystem/grpc-gateway/v2@v2.19.1/examples/internal/proto/examplepb/ignore_comment.proto (about)

     1  syntax = "proto3";
     2  
     3  package grpc.gateway.examples.internal.proto.examplepb;
     4  
     5  import "google/api/annotations.proto";
     6  import "protoc-gen-openapiv2/options/annotations.proto";
     7  
     8  option go_package = "github.com/grpc-ecosystem/grpc-gateway/v2/examples/internal/proto/examplepb";
     9  
    10  // This comment should be excluded from OpenAPI output
    11  service FooService {
    12    // This comment should be excluded from OpenAPI output
    13    rpc Foo(FooRequest) returns (FooReply) {
    14      option (google.api.http) = {
    15        post: "/v1/example/foo"
    16        body: "*"
    17      };
    18    }
    19  }
    20  
    21  // This comment should be excluded from OpenAPI output
    22  message FooRequest {
    23    // This comment should be excluded from OpenAPI output
    24    string username = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {description: "This annotation should be preserved"}];
    25    // This comment should be excluded from OpenAPI output
    26    string password = 2 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {title: "This annotation should be preserved"}];
    27  }
    28  
    29  // This comment should be excluded from OpenAPI output
    30  message FooReply {}