Support for service / rpc options

Is your feature request related to a problem? Please describe. Currently, the protobuf plug-in doesn’t appear to understand options defined on either the service level or rpc (method) level.

Describe the solution you’d like The protobuf v3 spec allows for options defined at the service and rpc (method) level.

Additional context Example (using Google’s http.proto): https://github.com/googleapis/googleapis/blob/2a57c3158a97597941220e64a940760d6a738a69/google/api/http.proto#L129-L136

When using the plug-in today, I get various errors when using service or rpc options:

• When using a built-in option, I get an error regarding an unresolved reference (this reference should be found in the descriptor.proto file):

service MyService {
    option idempotency_level = NO_SIDE_EFFECTS;
    ...
}

• When using a custom option, I get an error regarding extraneous input (after the semicolon in the option):

service MyService
    option (company.grpc.custom_rule) = {
        my_field: "abc"; // Error after semicolon here
        my_list_field: ["a", "b", "c"];
    };
    ...
}

[frennkie]

you need to add a “Custom Include Path” to the Protobuf plugin config

I wasn’t aware of this… thanks.

Still I have same problem that I get an error on the semi-colon (after "go-ws-api";) and on the next line on the first word (version). The files compile without any issue.

syntax = "proto3";
package echopb;

import "google/api/annotations.proto";
import "protoc-gen-swagger/options/annotations.proto";

option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
    info: {
        title: "go-ws-api";
        version: "1.0";
        contact: {
            name: "go-ws-api";
            url: "https://github.com/mch1307/ws-go-api";
            email: "[e-mail]";
        };
    };
    schemes: HTTP;
    schemes: HTTPS;
    consumes: "application/json";
    produces: "application/json";
};

message EchoMessage {
 string value = 1;
}

service EchoService {
  rpc Echo(EchoMessage) returns (EchoMessage) {
    option (google.api.http) = {
      post: "/v1/echo"
      body: "*"
    };
  }
}

Code mostly take from: https://blog.csnet.me/blog/building-a-go-api-grpc-rest-and-openapi-swagger.1/

It would be great if this could be fixed in the plugin! 😄

[ping-localhost]

I’ve just hit this wall as well and it’s really bugs me, since I have a valid file without any syntax highlighting because it’s considered invalid. 😢