-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Document protoc-gen-swagger #427
Comments
The parsing should be the same as for the gateway code. Can you elaborate on what more you would be interested in having than the link in our docs that says custom option? |
I don't really know what you're referring to here. As an end user I was hoping not to have to look into the source. However, I've seen from digging around in the source of this plugin that various rules are applied to comments, like:
It'd be useful to have a guide that explicitly states all these rules along with examples so it's obvious how .proto files should be commented so that swagger files are correctly generated in terms of documentation. |
You can always look at our kitchen sink for a fully fleshed out version of a proto. It should have one of everything. |
/sub.
and then let the tool overwrite/add things parsed from the proto. |
I think subscribing to #521 is probably the way to go here. Is that PR what you were thinking of? |
There's no obvious documentation on how to actually comment .proto files so they can be parsed by protoc-gen-swagger. It'd be useful if some was added.
The text was updated successfully, but these errors were encountered: