Skip to content

fix: Exclude methods without HTTP bindings from OpenAPI definitions #6030

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

Merged
johanbrandhorst merged 2 commits into from
Dec 1, 2025
+144 −1
Merged

fix: Exclude methods without HTTP bindings from OpenAPI definitions #6030

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fba732
fix
iamrajiv Oct 23, 2025
486cec7
add test
iamrajiv Dec 1, 2025
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
6 changes: 5 additions & 1 deletion protoc-gen-openapiv2/internal/genopenapi/generator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,11 @@ func TestGenerateExtension(t *testing.T) {
name: "Test"
input_type: ".example.v1.Foo"
output_type: ".example.v1.Foo"
options: {}
options: {
[google.api.http]: {
get: "/v1/test"
}
}
}
}
options: {
Expand Down
6 changes: 6 additions & 0 deletions protoc-gen-openapiv2/internal/genopenapi/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,12 @@ func findServicesMessagesAndEnumerations(s []*descriptor.Service, reg *descripto
continue
}

// Only process methods with HTTP bindings (exposed via HTTP annotations)
// This prevents unused message definitions from appearing in the OpenAPI document
if len(meth.Bindings) == 0 {
continue
}

swgReqName, ok := fullyQualifiedNameToOpenAPIName(meth.RequestType.FQMN(), reg)
if !ok {
grpclog.Errorf("couldn't resolve OpenAPI name for FQMN %q", meth.RequestType.FQMN())
Expand Down
Loading