Plugin request for sudorandom/protoc-gen-connect-openapi

[mfridman]

This plugin has been mentioned several times in the Slack channel. I created this issue to assess its potential as a plugin and to gauge community feedback.

It might not be possible because from a cursory glance it required an auxiliary yaml file.

Mandatory

Where is the source code for the plugin?

https://github.com/sudorandom/protoc-gen-connect-openapi

Optional

Does the plugin have a valid semver version?

Yes, https://github.com/sudorandom/protoc-gen-connect-openapi/releases/tag/v0.7.2

Does the output of this plugin depend on any other external libraries?

Not sure

[sudorandom]

Hi, I authored this plugin! Adding a few more details:

Does the output of this plugin depend on any other external libraries?

I believe the answer is no.

-- potentially irrelevant info -- From a Go point of view, this plugin uses this library to generate OpenAPI JSON/YAML: github.com/pb33f/libopenapi. All Go libraries can be found in go.mod. All libraries, however, are written in Go.

This plugin uses options from gnostic, protovalidate, and google/api/annotations.HttpRule from gRPC/HTTP transcoding so all of those options can influence output. -- end potentially irrelevant info --

It might not be possible because from a cursory glance it required an auxiliary yaml file.

It does not require this YAML file. Some examples show using a base YAML file in order to more easily define some things in the output without requiring adding options to your protobuf file(s).

[nadilas]

Hi @mfridman, could we revisit this? OAS3 is still a painpoint.

[mfridman]

Thanks for flagging it, and thank you for the additional details. I can't promise anything, but I'll bring it up with the team.

[ehmo]

Hi, any news on this? I would appreciate if it was added to the registry.