JAX-RS BeanParam issue with multipart/formdata and file upload

I try to put the form parameters of a multipart request into a bean like this:

@Consumes(MediaType.MULTIPART_FORM_DATA)
@Produces(MediaType.APPLICATION_JSON)
public Response uploadWithBean(@Parameter @BeanParam UploadRequest personData) {
	InputStream upload = personData.getUpload();
	if (upload == null) {
		return Response.ok(UploadResponse.FAILED).build();
	}
	return Response.ok(UploadResponse.SUCCESS).build();
}

In this case, the JSON produced ist the following:

"schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "picture": {
                    "$ref": "#/components/schemas/FormDataContentDisposition"
                  }
                }
              }

instead of (without the @BeanParam annotation).

"schema": {
                "$ref": "#/components/schemas/UploadRequest"
}

If I leave the @BeanParam annotation, i would get a 415 response code, so this seems to be the right way.

If I further annotate the file-parameter InputStream of my bean, the upload will not occur and InputStream is null.

@Schema(name = "UploadRequest", title="Schema for Upload")
public class UploadRequest  {
	@FormDataParam("name")
	// @Schema(name="name", type="string", accessMode=AccessMode.READ_WRITE)
	private String name;

	@FormDataParam("picture")
	@Schema(name="picture", type="string", format="binary") // <----- upload is NULL when @Schema is present
	private InputStream upload;
	
	@FormDataParam("picture")
	private FormDataContentDisposition disposition;
}

See the provided example to test. swagger-test-upload.zip

[markusdemetz]

#3580 (available in next release 2.1.3) fixes the handling of hidden annotations with @BeanParam, therefore the @RequestBody annotation on the resource method will not be needed.

The @RequestBody is still needed to work properly (using 2.1.4). When the mapping ist annotated, it produces the following JSON:

Without annotation, I get:

The former is correct, but the “upload”-schema is useless, or am I wrong? Provided example is attached.

swagger-test-upload2.zip

[eak24]

Turns out that the issue was that we were using private fields with an underscore at the end, and so some part of Jackson/Swagger core wasn’t able to apply the annotations (pathparam, queryparam, etc…) to the interpreted field from the public getter/setter like so:

public class MyClass {
  
    @PathParam
    private String privateField_;

    private String getPrivateField() {
        return privateField_;
    }
}

So in this example, Swagger core didn’t see that privateField was an accessible PathParam. I’m fine with this limitation, and I see there is no simple, robust way for Swagger core to correlate the field with the method, but I’m still a little confused because the beanParam resolution does happen correctly on the server - ie, Spring is able to properly inject the BeanParam, so why can’t Swagger core use the logic that Spring uses?