Primitive RequestPart parameters generate incorrect Swagger Model

Method parameters of the following form will generate incorrect parameters in Swagger 2. Non-validating parsers will not immediately choke on it, but code generators like swagger-codegen or openapi-codegen will.

  public SomeReturnValue webMethod(
    @RequestPart("file") MultipartFile file,
    @RequestPart("description") String description) {
...

The generated spec will look like this:

                    {
                        "name": "file",
                        "in": "formData",
                        "description": "file",
                        "required": true,
                        "type": "file"
                    },
                    {
                        "in": "formData",
                        "name": "description",
                        "description": "description",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }

This is a problem because parameters with in=formData can’t have a schema, only a type is allowed. The spec doesn’t allow formData parameters to be anything other than a primitive.

The expected JSON should be:

                    {
                        "name": "file",
                        "in": "formData",
                        "description": "file",
                        "required": true,
                        "type": "file"
                    },
                    {
                        "in": "formData",
                        "name": "description",
                        "description": "description",
                        "required": true,
                        "type": "string"
                    }

[spylightadmin]

We have the same problem in v2.9.2, any update on this?

[msangals]

I’m running springfox at version 2.9.2

When you build a custom ApiDescription with the ParametersBuilder as follow:

new ParameterBuilder()
    .name("password")
    .parameterType("formData")
    .required(true)
    .modelRef(new ModelRef("string"))
    .build()

Generates the same broken JSON for formData:

                   {
                        "in": "formData",
                        "name": "password",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }

The expected valid JSON is:

                   {
                        "in": "formData",
                        "name": "password",
                        "required": true,
                        "type": "string"
                    }