Changes report: Schema properties are ignored in method-level @RequestBody #1664

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/SpringDocAnnotationsUtils.java

@@ -44,6 +44,7 @@
 import io.swagger.v3.core.util.AnnotationsUtils;
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.SchemaProperty;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.ComposedSchema;
@@ -348,6 +349,46 @@ private static MediaType getMediaType(Schema schema, Components components, Json
 			if (components != null) {
 				try {
 					getSchema(annotationContent, components, jsonViewAnnotation).ifPresent(mediaType::setSchema);
+					if (annotationContent.schemaProperties().length > 0) {
+						if (mediaType.getSchema() == null) {
+							mediaType.schema(new Schema<Object>().type("object"));
+						}
+						Schema oSchema = mediaType.getSchema();
+						for (SchemaProperty sp: annotationContent.schemaProperties()) {
+							Class<?> schemaImplementation = sp.schema().implementation();
+							boolean isArray = false;
+							if (schemaImplementation == Void.class) {
+								schemaImplementation = sp.array().schema().implementation();
+								if (schemaImplementation != Void.class) {
+									isArray = true;
+								}
+							}
+							getSchema(sp.schema(), sp.array(), isArray, schemaImplementation, components, jsonViewAnnotation)
+									.ifPresent(s -> {
+										if ("array".equals(oSchema.getType())) {
+											oSchema.getItems().addProperty(sp.name(), s);
+										} else {
+											oSchema.addProperty(sp.name(), s);
+										}
+									});
+
+						}
+					}
+					if (
+							hasSchemaAnnotation(annotationContent.additionalPropertiesSchema()) &&
+									mediaType.getSchema() != null &&
+									!Boolean.TRUE.equals(mediaType.getSchema().getAdditionalProperties()) &&
+									!Boolean.FALSE.equals(mediaType.getSchema().getAdditionalProperties())) {
+						getSchemaFromAnnotation(annotationContent.additionalPropertiesSchema(), components, jsonViewAnnotation)
+								.ifPresent(s -> {
+											if ("array".equals(mediaType.getSchema().getType())) {
+												mediaType.getSchema().getItems().additionalProperties(s);
+											} else {
+												mediaType.getSchema().additionalProperties(s);
+											}
+										}
+								);
+					}
 				}
 				catch (Exception e) {
 					if (isArray(annotationContent))

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app83/HelloController.java

@@ -25,7 +25,10 @@
 package test.org.springdoc.api.v30.app83;
 
 import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.media.SchemaProperty;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
 
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
@@ -52,4 +55,15 @@ public ResponseEntity<?> put(
 		return null;
 	}
 
+	@RequestMapping(value = "/test",
+			method = RequestMethod.PUT,
+			consumes = { MediaType.MULTIPART_FORM_DATA_VALUE },
+			produces = { MediaType.APPLICATION_JSON_VALUE }
+	)
+	@RequestBody(content =@Content(schema  = @Schema( requiredProperties = "file",  type = "object")
+			, schemaProperties = @SchemaProperty(name = "file", schema = @Schema(type = "string", format = "binary"))
+	))
+	public ResponseEntity<?> put2() {
+		return null;
+	}
 }

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app83.json

@@ -63,6 +63,44 @@
           }
         }
       }
+    },
+    "/test": {
+      "put": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "put2",
+        "requestBody": {
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "required": [
+                  "file"
+                ],
+                "type": "object",
+                "properties": {
+                  "file": {
+                    "type": "string",
+                    "format": "binary"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {}