Options defined in the OpenAPI config file should take precedence over configs in the Proto file

[numacci21]

🚀 Feature

As pointed out in #2858, users usually use the openapi configuration file when they can't edit the protobuf file for some reason. So it would be better for the options defined in the openapi configuration file to take precedence.

Currently, only Service has been modified to give priority to the options defined in the OpenAPI configuration file, while the Method, Message, File and Field still give priority to the options defined in the Proto file.

What we need to do

Fix each getXxxOpenAPIOption method so that it first retrieves the options defined in the OpenAPI configuration file, and uses the values defined in the Proto file only if the OpenAPI config options are empty.

It would be nice to check if the automatically generated examples do not change and add some test cases if needed.

For Method, we may need to fix the function below.

grpc-gateway/protoc-gen-openapiv2/internal/genopenapi/template.go

Line 2488 in 031bc11

func getMethodOpenAPIOption(reg *descriptor.Registry, meth *descriptor.Method) (*openapi_options.Operation, error) {

Service has already been fixed. You can refer to the following implementation when fixing the others.

grpc-gateway/protoc-gen-openapiv2/internal/genopenapi/template.go

Line 2518 in 031bc11

func getServiceOpenAPIOption(reg *descriptor.Registry, svc *descriptor.Service) (*openapi_options.Tag, error) {

I think we need to add notes to the doc, as changing the configuration files' priority may impact existing users.

[avinilcodes]

I would like to contribute, can you please assign this to me.

[johanbrandhorst]

Please feel free to open a PR, there's no need to assign the issue. Thanks!