Skip to content

protoc-gen-openapi: fix schema name collision for deeply nested messages #473

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
DenKoren wants to merge 2 commits into
base: main
Choose a base branch
from
+27 −16
Open

protoc-gen-openapi: fix schema name collision for deeply nested messages #473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
249cf6b
Fix schema name collision for deeply nested proto messages
DenKoren Apr 1, 2026
a43ebba
Add no_recursive_schema_naming option for backward compatibility
DenKoren Apr 1, 2026
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
19 changes: 10 additions & 9 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 @@ -35,15 +35,16 @@ import (
)

type Configuration struct {
Version *string
Title *string
Description *string
Naming *string
FQSchemaNaming *bool
EnumType *string
CircularDepth *int
DefaultResponse *bool
OutputMode *string
Version *string
Title *string
Description *string
Naming *string
FQSchemaNaming *bool
NoRecursiveSchemaNaming *bool
EnumType *string
CircularDepth *int
DefaultResponse *bool
OutputMode *string
}

const (
Expand Down
21 changes: 15 additions & 6 deletions cmd/protoc-gen-openapi/generator/reflector.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,23 @@ func NewOpenAPIv3Reflector(conf Configuration) *OpenAPIv3Reflector {
}

func (r *OpenAPIv3Reflector) getMessageName(message protoreflect.MessageDescriptor) string {
prefix := ""
name := string(message.Name())
parent := message.Parent()

if _, ok := parent.(protoreflect.MessageDescriptor); ok {
prefix = string(parent.Name()) + "_" + prefix
if *r.conf.NoRecursiveSchemaNaming {
if msg, ok := parent.(protoreflect.MessageDescriptor); ok {
name = string(msg.Name()) + "_" + name
}
return name
}

return prefix + string(message.Name())
for {
msg, ok := parent.(protoreflect.MessageDescriptor)
if !ok {
break
}
name = string(msg.Name()) + "_" + name
parent = msg.Parent()
}
return name
}

func (r *OpenAPIv3Reflector) formatMessageName(message protoreflect.MessageDescriptor) string {
Expand Down
3 changes: 2 additions & 1 deletion cmd/protoc-gen-openapi/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ func main() {
Title: flags.String("title", "", "name of the API"),
Description: flags.String("description", "", "description of the API"),
Naming: flags.String("naming", "json", `naming convention. Use "proto" for passing names directly from the proto files`),
FQSchemaNaming: flags.Bool("fq_schema_naming", false, `schema naming convention. If "true", generates fully-qualified schema names by prefixing them with the proto message package name`),
FQSchemaNaming: flags.Bool("fq_schema_naming", false, `schema naming convention. If "true", generates fully-qualified schema names by prefixing them with the proto message package name`),
NoRecursiveSchemaNaming: flags.Bool("no_recursive_schema_naming", false, `if "true", only include the immediate parent message name in schema names instead of the full message hierarchy. This restores the legacy naming behavior where e.g. A.B.C.Request becomes C_Request instead of A_B_C_Request`),
EnumType: flags.String("enum_type", "integer", `type for enum serialization. Use "string" for string-based serialization`),
CircularDepth: flags.Int("depth", 2, "depth of recursion for circular messages"),
DefaultResponse: flags.Bool("default_response", true, `add default response. If "true", automatically adds a default response to operations which use the google.rpc.Status message. Useful if you use envoy or grpc-gateway to transcode as they use this type for their default error responses.`),
Expand Down