Skip to content

feat: add summary field to operations from first non-empty comment line #450

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add summary field to operations from first non-empty comment line #450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions cmd/protoc-gen-openapi/generator/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,7 @@ func (g *OpenAPIv3Generator) buildOperationV3(
// Create the operation.
op := &v3.Operation{
Tags: []string{tagName},
Summary: extractSummary(description),
Description: description,
OperationId: operationID,
Parameters: parameters,
Expand Down Expand Up @@ -668,6 +669,17 @@ func (g *OpenAPIv3Generator) buildOperationV3(
return op, path
}

func extractSummary(comment string) string {
lines := strings.Split(comment, "\n")
for _, line := range lines {
trimmed := strings.TrimSpace(line)
if trimmed != "" {
return trimmed
}
}
return ""
}

// addOperationToDocumentV3 adds an operation to the specified path/method.
func (g *OpenAPIv3Generator) addOperationToDocumentV3(d *v3.Document, op *v3.Operation, path string, methodName string) {
var selectedPathItem *v3.NamedPathItem
Expand Down