A HTTP header in multipart/form-data is handled as form item instead of header. fixes #1842

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java

@@ -335,7 +335,8 @@ else if (!RequestMethod.GET.equals(requestMethod) || OpenApiVersion.OPENAPI_3_1.
 			while (it.hasNext()) {
 				Entry<ParameterId, Parameter> entry = it.next();
 				Parameter parameter = entry.getValue();
-				if (!ParameterIn.PATH.toString().equals(parameter.getIn())) {
+				if (!ParameterIn.PATH.toString().equals(parameter.getIn()) && !ParameterIn.HEADER.toString().equals(parameter.getIn() )
+						&& !ParameterIn.COOKIE.toString().equals(parameter.getIn())) {
 					io.swagger.v3.oas.models.media.Schema<?> itemSchema = new io.swagger.v3.oas.models.media.Schema<>();
 					itemSchema.setName(entry.getKey().getpName());
 					itemSchema.setDescription(parameter.getDescription());

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app52/HelloController.java

@@ -27,6 +27,7 @@
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestPart;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.multipart.MultipartFile;
@@ -42,7 +43,7 @@ public String createTest1(@PathVariable String username, @RequestPart("test") My
 
 	@PostMapping(value = "/test2/{username}", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
 	public String createTest2(@PathVariable String username, @RequestPart("image") MultipartFile imageFile,
-			@RequestPart("test") MyTestDto test) {
+			@RequestPart("test") MyTestDto test, @RequestHeader("My-Header") String workspaceId) {
 		return null;
 	}
 

springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app52.json

@@ -11,38 +11,31 @@
     }
   ],
   "paths": {
-    "/test1/{username}": {
+    "/test3": {
       "post": {
         "tags": [
           "hello-controller"
         ],
-        "operationId": "createTest1",
-        "parameters": [
-          {
-            "name": "username",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
+        "operationId": "createTest3",
         "requestBody": {
           "content": {
             "multipart/form-data": {
               "schema": {
                 "required": [
-                  "image",
+                  "doc",
                   "test"
                 ],
                 "type": "object",
                 "properties": {
-                  "image": {
-                    "type": "string",
-                    "format": "binary"
-                  },
                   "test": {
                     "$ref": "#/components/schemas/MyTestDto"
+                  },
+                  "doc": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "format": "binary"
+                    }
                   }
                 }
               }
@@ -77,6 +70,14 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "name": "My-Header",
+            "in": "header",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -115,31 +116,38 @@
         }
       }
     },
-    "/test3": {
+    "/test1/{username}": {
       "post": {
         "tags": [
           "hello-controller"
         ],
-        "operationId": "createTest3",
+        "operationId": "createTest1",
+        "parameters": [
+          {
+            "name": "username",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
         "requestBody": {
           "content": {
             "multipart/form-data": {
               "schema": {
                 "required": [
-                  "doc",
+                  "image",
                   "test"
                 ],
                 "type": "object",
                 "properties": {
-                  "doc": {
-                    "type": "array",
-                    "items": {
-                      "type": "string",
-                      "format": "binary"
-                    }
-                  },
                   "test": {
                     "$ref": "#/components/schemas/MyTestDto"
+                  },
+                  "image": {
+                    "type": "string",
+                    "format": "binary"
                   }
                 }
               }