Repository navigation
[proto-gen-openapi] Wrong message included when message with same name exists in imported proto #392
Description
We just noticed that gnostic's proto-gen-openapi may create a wrong OpenAPI v3 spec when a message with identical name exists in an imported proto even though the messages belong to different packages. This happens although the message from the imported proto is not used at all in the base proto.
Reproduction: https://github.com/n0v1/gnostic-gen-openapi-naming-issue-repro (see readme and proto files for details)
The generated API spec only includes HelloWorld from bar.proto (which is not used anywhere). I would expect it to include HelloWorld from foo.proto instead. Even using the fully-qualified name com.example.foo.HelloWorld in FooResponse does not fix this.
Setting option fq_schema_naming=true fixes it but I think even without this option proto-gen-openapi should not create a wrong specification. It should at least give a warning or throw an error when a message/schema name is ambiguous.
Activity
zaakn commentedon Nov 7, 2023
As a similar case:
I imported
openapiv3/annotations.protowhich has a message namedContact(actually inopenapiv3/OpenAPIv3.proto) to setoption (openapi.v3.document). And thisContactis not used in my ownfoo.proto.At the same time,
Contacthas been defined and used infoo.proto(package foo)proto-gen-openapiunexpectedly treatsfoo.Contactasopenapi.v3.Contactcompletely whenfq_schema_naming=false.fix: Select the corret schemas that correspond to the messages used