Skip to content

Support openapiv2_tag option in swagger generator #690

Closed
@achow14

Description

@achow14

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions