protoc-gen-swagger comment parsing for documentation gen #128
Comments
|
Unfortunately that is not something that I implemented. Fortunately I don't think it would be extremely difficult if you wanted to take a swing at contributing. The comments are in the SourceCodeInfo_Location object inside the FileDescriptorProto when genswagger iterates over the files. If you need more pointers than that please comment on this issue and I'll see what I can do. Thanks for reaching out! |
ivucica
added a commit
to ivucica/grpc-gateway
that referenced
this issue
Apr 17, 2016
While this is a first step in resolving grpc-ecosystem#128, this needs to be cleaned up, and the same approach needs to be used for messages, message fields, et al. echo_service.proto has been annotated with extra comments in order to demo the new descriptions. Only the Swagger example has been regenerated, as my local generator does not output all the expected fields in proto struct tags.
ivucica
added a commit
to ivucica/grpc-gateway
that referenced
this issue
Apr 18, 2016
While this is a first step in resolving grpc-ecosystem#128, this needs to be cleaned up, and the same approach needs to be used for messages, message fields, et al. echo_service.proto has been annotated with extra comments in order to demo the new descriptions. Only the Swagger example has been regenerated, as my local generator does not output all the expected fields in proto struct tags.
|
It looks like #134 covers this issue. Hopefully that will be merged in soon. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is there, by chance, any documentation on how to properly format comments so that the swagger fields in the JSON will be nicely populated for documentation purposes?
The text was updated successfully, but these errors were encountered: