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

documentation of semantics of endpoint declarations #212

Closed
sdemos opened this issue Aug 9, 2016 · 3 comments
Closed

documentation of semantics of endpoint declarations #212

sdemos opened this issue Aug 9, 2016 · 3 comments

Comments

@sdemos
Copy link
Contributor

sdemos commented Aug 9, 2016

After working with this project for a little while, I finally found Google's description of the semantics that are used in this package. It would be super helpful if that (or a better version of that) were linked to prominently in the README.md. It would be even better if the specific way that this library implemented that description was documented, so that someone learning how to use this library doesn't have to just mess around with the library to see how it works. The implicit generation of query parameters especially threw me, I didn't realize that this library could even do that until someone mentioned it in another issue.

@yugui
Copy link
Member

yugui commented Aug 9, 2016

Thank you for your feedback. We should definitely have had such documentation.

@BrianHicks
Copy link

@sdemos thank you so much for that link. I was having the same problem with finding documentation.

@philips
Copy link

philips commented Aug 19, 2016

@sdemos are you going to submit a PR to close this out?

sdemos added a commit to sdemos/grpc-gateway that referenced this issue Sep 7, 2016
This commit adds links to the google cloud platform's documentation on
the custom options used by grpc-gateway to generate your http proxy.
This documentation has information about how path, query, and body
parameters are handled, as well as specific assumptions about the
arguments present for different http methods.

Fixes grpc-ecosystem#212
@tamalsaha tamalsaha mentioned this issue Mar 30, 2017
1 task
adasari pushed a commit to adasari/grpc-gateway that referenced this issue Apr 9, 2020
This commit adds links to the google cloud platform's documentation on
the custom options used by grpc-gateway to generate your http proxy.
This documentation has information about how path, query, and body
parameters are handled, as well as specific assumptions about the
arguments present for different http methods.

Fixes grpc-ecosystem#212
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

4 participants