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

Populate swagger method parameter description from message comments #692

Merged
merged 1 commit into from Jul 4, 2018

Conversation

Projects
None yet
4 participants
@co3k
Contributor

co3k commented Jul 3, 2018

No description provided.

@googlebot googlebot added the cla: yes label Jul 3, 2018

@johanbrandhorst

This comment has been minimized.

Show comment
Hide comment
@johanbrandhorst

johanbrandhorst Jul 3, 2018

Collaborator

Hi @co3k, and thanks for your contribution! The title of this PR (and commit message) confuses me, could you reword it please? I don't understand what this does just from reading the title.

Collaborator

johanbrandhorst commented Jul 3, 2018

Hi @co3k, and thanks for your contribution! The title of this PR (and commit message) confuses me, could you reword it please? I don't understand what this does just from reading the title.

@co3k

This comment has been minimized.

Show comment
Hide comment
@co3k

co3k Jul 3, 2018

Contributor

@johanbrandhorst
Oh, I'm sorry for confusing you. How about the following?

- Reflect descriptions of message to Swagger parameter representation automatically
+ Reflect comments of proto message as description of Swagger's Parameter Object representation implicitly
Contributor

co3k commented Jul 3, 2018

@johanbrandhorst
Oh, I'm sorry for confusing you. How about the following?

- Reflect descriptions of message to Swagger parameter representation automatically
+ Reflect comments of proto message as description of Swagger's Parameter Object representation implicitly
@johanbrandhorst

This comment has been minimized.

Show comment
Hide comment
@johanbrandhorst

johanbrandhorst Jul 3, 2018

Collaborator

Let me see if I understand correctly. Would this also be a correct description?

Populate swagger method parameter description from message comments

If so, I think that is clearer yet than your update ;).

Collaborator

johanbrandhorst commented Jul 3, 2018

Let me see if I understand correctly. Would this also be a correct description?

Populate swagger method parameter description from message comments

If so, I think that is clearer yet than your update ;).

@co3k co3k changed the title from Reflect descriptions of message to Swagger parameter representation automatically to Populate swagger method parameter description from message comments Jul 3, 2018

@co3k

This comment has been minimized.

Show comment
Hide comment
@co3k

co3k Jul 3, 2018

Contributor

@johanbrandhorst Thank you for your good suggestion. I've updated the title of this pull request and the commit message.

Contributor

co3k commented Jul 3, 2018

@johanbrandhorst Thank you for your good suggestion. I've updated the title of this pull request and the commit message.

@codecov-io

This comment has been minimized.

Show comment
Hide comment
@codecov-io

codecov-io Jul 3, 2018

Codecov Report

Merging #692 into master will increase coverage by 0.01%.
The diff coverage is 64.28%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #692      +/-   ##
==========================================
+ Coverage   56.47%   56.48%   +0.01%     
==========================================
  Files          30       30              
  Lines        3005     3013       +8     
==========================================
+ Hits         1697     1702       +5     
- Misses       1145     1146       +1     
- Partials      163      165       +2
Impacted Files Coverage Δ
protoc-gen-swagger/genswagger/template.go 38.47% <64.28%> (+0.24%) ⬆️

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 39a18c6...afbe113. Read the comment docs.

codecov-io commented Jul 3, 2018

Codecov Report

Merging #692 into master will increase coverage by 0.01%.
The diff coverage is 64.28%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #692      +/-   ##
==========================================
+ Coverage   56.47%   56.48%   +0.01%     
==========================================
  Files          30       30              
  Lines        3005     3013       +8     
==========================================
+ Hits         1697     1702       +5     
- Misses       1145     1146       +1     
- Partials      163      165       +2
Impacted Files Coverage Δ
protoc-gen-swagger/genswagger/template.go 38.47% <64.28%> (+0.24%) ⬆️

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 39a18c6...afbe113. Read the comment docs.

@johanbrandhorst johanbrandhorst merged commit e93c623 into grpc-ecosystem:master Jul 4, 2018

2 checks passed

cla/google All necessary CLAs are signed
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@co3k co3k deleted the co3k:reflect-message-comments-to-path-parameters branch Jul 4, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment