Fix protoc-gen-swagger to output gRPC method summary and descriptions as Swagger's them

[co3k]

No description provided.

[codecov-io]

Codecov Report

Merging #667 into master will decrease coverage by 0.09%.
The diff coverage is 5.26%.

@@            Coverage Diff            @@
##           master     #667     +/-   ##
=========================================
- Coverage   56.43%   56.34%   -0.1%     
=========================================
  Files          30       30             
  Lines        3005     3010      +5     
=========================================
  Hits         1696     1696             
- Misses       1145     1150      +5     
  Partials      164      164

Impacted Files	Coverage Δ
protoc-gen-swagger/genswagger/template.go	38.27% <5.26%> (-0.25%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9b9677c...9566623. Read the comment docs.

[achew22]

@co3k, thanks so much for your pull request. Looking through, I'm a bit puzzled by what it should do. It looks like the changes to the golden .go files all come from changes upstream. If this code path isn't exercised by our examples, do you think you could add an example that does exercise it so I can see the new functionality?

[co3k]

@achew22

It looks like the changes to the golden .go files all come from changes upstream

I added these changes to pass build on Travis CI. In the other pull request, I've encountered build error that is caused by the upstream changes. https://travis-ci.org/grpc-ecosystem/grpc-gateway/builds/390065893

do you think you could add an example that does exercise it so I can see the new functionality?

You're right. I've added the ce1532e commit to show it.

[achew22]

Oops, I left that comment on the commit directly -- sorry. Can you make the indentation match the rest of the file?

[co3k]

Oh, sorry for the mistakes. I fixed it by 4b6f889

[johanbrandhorst]

Hi! Can you please rebase this on top of master? There was recently a change to the swagger generator. You can run something like:

make realclean && make examples SWAGGER_CODEGEN="java -jar $HOME/local/swagger-codegen-cli.jar"

from the root of the repo to regenerate all examples. This will require swagger-codegen (and Java) installed.

[co3k]

@johanbrandhorst I rebased my changes and tests on Travis CI are passed.

[johanbrandhorst]

Hi, could you squash the commits as well please? Sorry I didn't specify this in the last message.

[co3k]

@johanbrandhorst OK, I've just squashed them.

[johanbrandhorst]

Thanks, I will leave it for @achew22 to approve and merge, but I'm a little confused by the PR description. Looking at the code this change looks like it parses the method comment and adds it to "Summary" and "Description" in accordance with other such comment parsing, but the PR title, description and commit message is a little confusing. Could you reword it for clarity please?

[achew22]

@johanbrandhorst another neat thing about the squash button on github is that you enter the description of the new squashed commit which makes it perfect for these situations. 2 commits squashed down into 1 and then the description hopefully clarified.

@co3k Thanks so much for your contribution! This will help in producing great documentation for APIs.