-
Notifications
You must be signed in to change notification settings - Fork 13
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
Conversation
@@ -0,0 +1,9 @@ | |||
version: v1 | |||
name: buf.build/community/google-gnostic-openapi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
If we have some cycles, we should consider adding a sample image that imports:
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). |
@@ -0,0 +1,9 @@ | |||
version: v1 | |||
name: buf.build/community/google-gnostic-openapi |
There was a problem hiding this comment.
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.
Co-authored-by: Philip K. Warren <[email protected]>
Fix #821