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

Add description, summary and tags fields in operationObject (swagger) #526

Merged

Conversation

devnull-
Copy link
Contributor

Hello all,

Small PR to add description, summary and tags fields in operationObject (swagger -- #145). Tags field was already fixed by @thurt in #524 but not merge (yet).

Devnull-

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.
  • If your company signed a CLA, they designated a Point of Contact who decides which employees are authorized to participate. You may need to contact the Point of Contact for your company and ask to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the project maintainer to go/cla#troubleshoot. The email used to register you as an authorized contributor must be the email used for the Git commit.
  • In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again. If the bot doesn't comment, it means it doesn't think anything has changed.

@devnull-
Copy link
Contributor Author

I signed it!

@googlebot
Copy link

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for the commit author(s). If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again. If the bot doesn't comment, it means it doesn't think anything has changed.

@devnull-
Copy link
Contributor Author

@googlebot : Add alternate email to validate the CLA.

@googlebot
Copy link

CLAs look good, thanks!

@achew22 achew22 merged commit f09fb17 into grpc-ecosystem:master Jan 21, 2018
@ivucica
Copy link
Collaborator

ivucica commented Feb 11, 2018

I like that this is in, but I think it worth adding a few caveats. For instance, I'd argue it's much more readable if summary and description are written as a proto comment. Special options seem a sane choice only if you have Swagger-specific text that doesn't apply to the gRPC service, or that should otherwise not end up in generated code.

tags field may be useful if same call appears in multiple services, or if the default of service name is not sufficiently human readable (e.g. developer wants spaces in the Swagger 'tag' name). But I would still suggest just using the default: the proto service name. Maybe we should have a proto option specifying a 'human readable' name for a service, instead?

Either way, this is neat, even if easy to misuse. Thumbs up 👍

adasari pushed a commit to adasari/grpc-gateway that referenced this pull request Apr 9, 2020
…grpc-ecosystem#526)

* Add Summary field (OperationObject -- Swagger)

* Add Description field (OperationObject -- Swagger)

* Add Tags field (OperationObject -- Swagger)

* Add description field (openapiv2_operation) in examplepb

* Add summary field (openapiv2_operation) in examplepb

* Add tags field (openapiv2_operation) in examplepb

* Swagger (JSON format) with summary, description and tags fields (openapiv2_operation)
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

Successfully merging this pull request may close these issues.

None yet

4 participants