Skip to content
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

Output swagger seems incorrect #688

Closed
lpabon opened this issue Jul 2, 2018 · 2 comments
Closed

Output swagger seems incorrect #688

lpabon opened this issue Jul 2, 2018 · 2 comments

Comments

@lpabon
Copy link

lpabon commented Jul 2, 2018

I'm using protoc 3.3.1 and proto-gen-go 1.1.0. When I output the swagger for api.proto and diff it with the previous output of grpc-gateway version 1.4.1 I get the following incorrect output diff:

       "post": {
-        "summary": "Create",
+        "summary": "Enumerate lists all the nodes in the cluster.",
         "operationId": "Create",
         "responses": {
           "200": {
@@ -90,7 +90,7 @@
     },
     "/v1/cloudbackup/catalog/{backup_id}": {
       "get": {
-        "summary": "Catalog",
+        "summary": "Restores a volume to a specified snapshot",
         "operationId": "Catalog",
         "responses": {
           "200": {
@@ -122,7 +122,7 @@
     },
     "/v1/cloudbackup/deleteall": {
       "post": {
-        "summary": "DeleteAll",
+        "summary": "Clear the alert for a given resource",
         "operationId": "DeleteAll",
         "responses": {
           "200": {
@@ -149,7 +149,7 @@

Seems something is incorrect. Is this due to a version issue or a bug in the swagger output?

@johanbrandhorst
Copy link
Collaborator

This is because #667, which fixed the Summary being taken from the comment on the RPC method. It is a feature. Do you wish to keep this issue open to argue that this is undesirable behaviour? Otherwise please close it.

@lpabon
Copy link
Author

lpabon commented Jul 3, 2018

Ah, interesting. Thanks for the info.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants