Repeated field documentation is overwritten by fields comments

[fahernandez]

Bug report:

When defining repeated fields the documentation of the field is overwritten by the fields comments. For example:

// Some field comments
repeated string names = 2 [(grpc.gateway.protoc_gen_swagger.options.openapiv2_field) =
    {
        description:
            "Some field description documentation."
           array: ["name1", "name2"];
    }];

After generating the swagger documentation the field comments takes precendence over the field documentation resulting in something like:

{
        "name": "names",
        "description": "Some field comments",
        "in": "query",
        "required": false,
        "type": "array",
        "items": {
             "type": "string"
         }
}

I think that the field documentation must take precedence over the field comments.

[achew22]

This would be a really great starter project for getting involved!

This comes from the interaction of these two pieces of code.

grpc-gateway/protoc-gen-swagger/genswagger/template.go

Lines 120 to 124 in c3923b1

	desc := schema.Description
	if schema.Title != "" { // merge title because title of parameter object will be ignored
	desc = strings.TrimSpace(schema.Title + ". " + schema.Description)
	}

grpc-gateway/protoc-gen-swagger/genswagger/template.go

Lines 294 to 296 in c3923b1

	if protoSchema.Description != "" {
	schema.Description = protoSchema.Description
	}

A little bit of rejiggering in there + a new test case and I think you'd be done if you're interested.

[fahernandez]

Sure, I will definitely try, thank you for taking me in the right direction!

[johanbrandhorst]

Closed by #863