Populate swagger method parameter description from message comments #692
Conversation
|
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. |
|
@johanbrandhorst - Reflect descriptions of message to Swagger parameter representation automatically
+ Reflect comments of proto message as description of Swagger's Parameter Object representation implicitly |
|
Let me see if I understand correctly. Would this also be a correct description?
If so, I think that is clearer yet than your update ;). |
co3k
changed the title
co3k
force-pushed
the
reflect-message-comments-to-path-parameters
branch
from
200974d to
14eab3f
Compare
|
@johanbrandhorst Thank you for your good suggestion. I've updated the title of this pull request and the commit message. |
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
| if meth.GetClientStreaming() { | ||
| desc = "(streaming inputs)" | ||
| desc = desc + "(streaming inputs)" |
There was a problem hiding this comment.
This can just be desc += " (streaming inputs)" right? (Also notice the space before the first bracket)
co3k
force-pushed
the
reflect-message-comments-to-path-parameters
branch
from
14eab3f to
afbe113
Compare
No description provided.