-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Support openapiv2_tag option in swagger generator #690
Labels
Comments
Sounds like adding support for the |
johanbrandhorst
changed the title
Headers/Tag Support?
Support openapiv2_tag option in swagger generator
Sep 9, 2018
Passing parameters via headers is not currently supported. Headers map to gRPC metadata. |
Hi, did someone stated fixing this issue? |
I don't think so! Would you like to contribute a fix? |
I might :) |
bandikishores
added a commit
to bandikishores/TestGo
that referenced
this issue
Mar 5, 2020
…have support for metadata yet - grpc-ecosystem/grpc-gateway#690
rcgoodfellow
pushed a commit
to mergetb/grpc-gateway
that referenced
this issue
Dec 8, 2020
Fixes grpc-ecosystem#690 Signed-off-by: Ryan Goodfellow <[email protected]>
PR for this: #1866 |
johanbrandhorst
pushed a commit
that referenced
this issue
Dec 9, 2020
* protoc-gen-openapiv2: support for openapiv2_tag Fixes #690 Signed-off-by: Ryan Goodfellow <[email protected]> * more consistent with rest of codebase Signed-off-by: Ryan Goodfellow <[email protected]> * update example specs, revert protoc version change Signed-off-by: Ryan Goodfellow <[email protected]> * Address review comments - Factor service tag rendering out of service rendering function - Add omitempty tags where applicable Signed-off-by: Ryan Goodfellow <[email protected]> * remove extraneous newline Signed-off-by: Ryan Goodfellow <[email protected]> * renderServices call to previous form Signed-off-by: Ryan Goodfellow <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hey guys,
I'm trying to use grpc-gateway to create a swagger.json directly from a .proto file
I was wondering if the tag option
option (grpc.gateway.protoc_gen_swagger.options.openapiv2_tag)
was working?
I pasted this tag option inside a service and it should change the description for the service "tag" if I'm not mistaken. When I do this and generate a swagger.json file, the services do not have descriptions appended to them. (Snippet Below)
service APIService {
option (grpc.gateway.protoc_gen_swagger.options.openapiv2_tag) = {
description: "Some Description";
};
rpc someService(Request) returns (Response)
}
In addition, for passing parameters, is there any kind of header support? Reading through the documentation, I've figured out that you have an optional body field and an automatic query parameter generation from the requests you pass into the rpc. However, is there any header parameter support that isn't in the documentation?
Thank you for the help.
The text was updated successfully, but these errors were encountered: