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 protoc-gen-openapi v0.7.0 #844

Merged
merged 3 commits into from
Oct 10, 2023
Merged

Add protoc-gen-openapi v0.7.0 #844

merged 3 commits into from
Oct 10, 2023

Conversation

mfridman
Copy link
Member

@mfridman mfridman commented Oct 3, 2023

Fix #821

@@ -0,0 +1,9 @@
version: v1
name: buf.build/community/google-gnostic-openapi
Copy link
Member Author

@mfridman mfridman Oct 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: buf.build/community/google-gnostic-openapi
name: buf.build/community/google-openapi

This alternative drops the "gnostic" from the name, which would be more in line with our existing nomenclature conventions of: {owner}-{name}

Where the repository component {owner} is the upstream GitHub owner and the {name} is usually the name of the plugin minus protoc-gen- prefix.

However, for this particular one having the name "gnostic" in the name makes the most sense given the project's background. For some context:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would like to wait for @pkwarren feedback before publishing this plugin.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer having the gnostic in the name too.

@mfridman
Copy link
Member Author

mfridman commented Oct 3, 2023

If we have some cycles, we should consider adding a sample image that imports:

import "google/api/annotations.proto";
import "openapiv3/annotations.proto";

That way we exercise bits of the plugin that actually use the annotations.

@pkwarren
Copy link
Member

pkwarren commented Oct 9, 2023

If we have some cycles, we should consider adding a sample image that imports:

import "google/api/annotations.proto";
import "openapiv3/annotations.proto";

That way we exercise bits of the plugin that actually use the annotations.

We did something similar to verify the grpc-gateway code. I think it would be good to do the same here but at least there is an openapi.yaml file generated for our existing inputs (even if it is mostly empty).

plugins/community/google-gnostic-openapi/v0.7.0/Dockerfile Outdated Show resolved Hide resolved
@@ -0,0 +1,9 @@
version: v1
name: buf.build/community/google-gnostic-openapi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer having the gnostic in the name too.

@mfridman mfridman merged commit 6874ed2 into main Oct 10, 2023
4 checks passed
@mfridman mfridman deleted the mf/openapi branch October 10, 2023 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Plugin request for Buf Schema Registry [protoc-gen-openapi]
2 participants