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

Is there a way generate summary for Operation in OpenAPI v3 in protoc-gen-openapi #305

Open
alexeyten opened this issue Feb 8, 2022 · 2 comments

Comments

@alexeyten
Copy link

As far as I could see for now there is only Description field.

// buildOperationV3 constructs an operation for a set of values.
func (g *OpenAPIv3Generator) buildOperationV3(
file *protogen.File,
operationID string,
tagName string,
description string,
defaultHost string,
path string,
bodyField string,
inputMessage *protogen.Message,
outputMessage *protogen.Message,
) (*v3.Operation, string) {

@ppaanngggg
Copy link
Contributor

#300 I create a pull request, using the first line of description as summary.

@timburks timburks changed the title Is there a way generate summary for Opetraion in OpenAPI v3 in protoc-gen-openapi Is there a way generate summary for Operation in OpenAPI v3 in protoc-gen-openapi Mar 14, 2022
@jeffsawatzky
Copy link
Contributor

@alexeyten / @timburks the linked PR was merged a while ago, so I think this can be closed. Also, you might be able to use the feature added in #324 to provide additional information doing something like
https://github.com/google/gnostic/blob/master/cmd/protoc-gen-openapi/examples/tests/openapiv3annotations/message.proto#L63

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

3 participants