Create official grpc-gateway protobuf template on the Buf Schema Registry

[rohilsurana]

🚀 Feature

Publishing the plugins protoc-gen-grpc-gateway and protoc-gen-openapiv2 would enable the ability to use these for remote generation of go packages on the Buf Schema registry, simplifying the development workflow.

Along with this we can also provide a template that the users can then directly use with their repos pushed on BSR with - go get go.buf.build/grpc-ecosystem/go-grpc-gateway/<username>/<repo>

[johanbrandhorst]

Hi, thanks for the issue! This could greatly simplify the simplest of use cases. Note that we already have an org and repository: https://buf.build/grpc-ecosystem/grpc-gateway. We would host these under the same parent org.

[rohilsurana]

Updated the go get command to use the existing org.

[johanbrandhorst]

Holding off on the template for now, but the grpc-gateway and openapiv2 plugins have been pushed. I will update the README once buf v0.55.0 is available as it allows users to select remote plugins for local generation.

[nightlyone]

@johanbrandhorst we have buf 1.4.x now and remote plugins arrived. Any updates on this?

[johanbrandhorst]

The remote plugins are in place, are you talking about an official grpc-gateway template? I think we'd like to wait until remote generation is out of alpha, I know they're still making some tweaks to it.

[AbhinavkumarL]

@johanbrandhorst Looks like the latest commit available on org/repo https://buf.build/grpc-ecosystem/grpc-gateway. from May 23rd. Is it possible to push the latest changes to the module to BSR ?

[johanbrandhorst]

Hi @AbhinavkumarL. Do you have a reason to believe that this is no longer the latest protobuf contents? The BSR won't create a new commit unless there are new files or changes to existing files. We also only run the proto_push workflow when there have been changes to one of the protobuf files: https://github.com/grpc-ecosystem/grpc-gateway/blob/1085fb38dc98034ae6a189b45b764fa1f3bef82a/.github/workflows/master.yml#L1-L6. The last push was https://github.com/grpc-ecosystem/grpc-gateway/actions/runs/2374364512.

[AbhinavkumarL]

@johanbrandhorst I see the openapiv2 plugin is up-to-date with reference v2.11.0-1. However, the commits published on the module is older. Looks like there is some inconsistency. I keep running in to the below error when i try to use buf generate to generate the protobuf from my proto files.

Failure: plugin openapiv2: repeated field not allowed in field path

I see this issue is recently fixed on the plugin in (https://github.com/grpc-ecosystem/grpc-gateway/pull/2813).

I checked with the buf build support. They mentioned the upstream maintainers need to push latest protos to BSR.

[johanbrandhorst]

I see the confusion. The problem is that the fix that you are relying on is not yet in a published release. If you want to use remote plugins, you'll need to keep the old option around for now:

version: v1
plugins:
  - remote: buf.build/grpc-ecosystem/plugins/openapiv2
    out: .
    opt:
      - allow_repeated_fields_in_body=true

Also, don't confuse plugin versioning for the versioning of the protobuf files. The protobuf files change very rarely. Everything on the BSR is up to date.

[AbhinavkumarL]

okay got it, Appreciate your time.