Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add managed module: buf.build/google/gnostic #482

Open
bufdev opened this issue Mar 18, 2024 · 3 comments · May be fixed by #549
Open

Add managed module: buf.build/google/gnostic #482

bufdev opened this issue Mar 18, 2024 · 3 comments · May be fixed by #549
Labels
Feature New feature or request Managed Modules

Comments

@bufdev
Copy link
Member

bufdev commented Mar 18, 2024

Mandatory

Where is the source code for the Managed Module?

https://github.com/google/gnostic

Specifically the openapiv3 directory, but also maybe the openapiv2 directory.

Do the proto files declare a package?

Yes, but not a great one: openapi.v3. Doesn't line up great with https://github.com/grpc-ecosystem/grpc-gateway/blob/main/protoc-gen-openapiv2/options/openapiv2.proto

Optional

Does this module have other module dependencies/imports?

No.

Based on the repository's release process, do you prefer syncing by SemVer releases or by git commit SHA?

SemVer releases.

Additionally, is there a sensible initial reference to sync from?

0.4.1 - it's the first one where the subdirectory is named openapiv3.

Do you think this module is widely used by the community, and is not already provided on the BSR by the owners?

Likely yes.

Other notes

  • Just a proposal.
  • Not sure how this fits in with other managed modules that potentially push OpenAPI API definitions.
  • Note that gnostic also has an openapi.v2 package in openapiv2 - should probably be pushing this up as well, but note grpc-gateway has definitions as well.
@bufdev bufdev added the Feature New feature or request label Mar 18, 2024
@mfridman
Copy link
Member

Not sure how involved Tim is with the project, but he did publish the definitions to the BSR:

https://buf.build/gnostic/gnostic/docs/main:gnostic.openapi.v3

Another alternative (not sure if a good one) is to open an issue on google/gnostic to suggest automating pushes to the BSR?

@bufdev
Copy link
Member Author

bufdev commented Mar 18, 2024

Oh, nice! Didn't know that

@unmultimedio unmultimedio linked a pull request May 14, 2024 that will close this issue
Copy link
Member

Sent a PR with instructions to sync both packages openapi.v2 and openapi.v3: #549

I'm not very familiar with the conflicts that the v2 pkg can have with the grpc-gateway definitions, but don't seem they're exactly 1:1 replicas.

Once that PR is merged and synced, I will test it in a staging cluster.

@unmultimedio unmultimedio removed their assignment May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature or request Managed Modules
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants