Wrong schema generation on endpoint consuming multipart form data combined with JsonView. fixes #1829

bnasslahsen · bnasslahsen · commit 12a047f92327 · 2022-10-14T14:49:32.000+02:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java
@@ -184,7 +184,7 @@ public class SpringDocConfigProperties {
 	/**
 	 * convert query param to form data when consumes is multipart/form-data
 	 */
-	private boolean defaultSupportFormData=true;
+	private boolean defaultSupportFormData;
 
 	/**
 	 * The model Converters
diff --git a/springdoc-openapi-javadoc/src/test/resources/results/app105-3.json b/springdoc-openapi-javadoc/src/test/resources/results/app105-3.json
@@ -473,6 +473,15 @@
               "type": "integer",
               "format": "int64"
             }
+          },
+          {
+            "name": "additionalMetadata",
+            "in": "query",
+            "description": "Additional data to pass to server",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -485,9 +494,6 @@
                 ],
                 "type": "object",
                 "properties": {
-                  "additionalMetadata": {
-                    "description": "Additional data to pass to server"
-                  },
                   "file": {
                     "type": "string",
                     "description": "file detail",
diff --git a/springdoc-openapi-javadoc/src/test/resources/results/app2.json b/springdoc-openapi-javadoc/src/test/resources/results/app2.json
@@ -495,8 +495,8 @@
               }
             }
           },
-          "404": {
-            "description": "Pet not found",
+          "200": {
+            "description": "successful operation",
             "content": {
               "application/xml": {
                 "schema": {
@@ -510,8 +510,8 @@
               }
             }
           },
-          "200": {
-            "description": "successful operation",
+          "404": {
+            "description": "Pet not found",
             "content": {
               "application/xml": {
                 "schema": {
@@ -670,6 +670,15 @@
               "type": "integer",
               "format": "int64"
             }
+          },
+          {
+            "name": "additionalMetadata",
+            "in": "query",
+            "description": "Additional data to pass to server",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -686,9 +695,6 @@
                     "type": "string",
                     "description": "file detail",
                     "format": "binary"
-                  },
-                  "additionalMetadata": {
-                    "description": "Additional data to pass to server"
                   }
                 }
               }
@@ -854,8 +860,8 @@
               }
             }
           },
-          "404": {
-            "description": "Order not found",
+          "200": {
+            "description": "successful operation",
             "content": {
               "application/xml": {
                 "schema": {
@@ -869,8 +875,8 @@
               }
             }
           },
-          "200": {
-            "description": "successful operation",
+          "404": {
+            "description": "Order not found",
             "content": {
               "application/xml": {
                 "schema": {
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app189/SpringDocApp189Test.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app189/SpringDocApp189Test.java
@@ -25,7 +25,10 @@
 import test.org.springdoc.api.v30.AbstractSpringDocV30Test;
 
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
 
+
+@TestPropertySource(properties = "springdoc.default-support-form-data=true")
 public class SpringDocApp189Test extends AbstractSpringDocV30Test {
 
     @SpringBootApplication
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app105-3.json b/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app105-3.json
@@ -331,6 +331,15 @@
               "type": "integer",
               "format": "int64"
             }
+          },
+          {
+            "name": "additionalMetadata",
+            "in": "query",
+            "description": "Additional data to pass to server",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -346,9 +355,6 @@
                     "type": "string",
                     "description": "file detail",
                     "format": "binary"
-                  },
-                  "additionalMetadata": {
-                    "description": "Additional data to pass to server"
                   }
                 }
               }
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app2.json b/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app2.json
@@ -655,6 +655,15 @@
               "type": "integer",
               "format": "int64"
             }
+          },
+          {
+            "name": "additionalMetadata",
+            "in": "query",
+            "description": "Additional data to pass to server",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -670,9 +679,6 @@
                     "type": "string",
                     "description": "file detail",
                     "format": "binary"
-                  },
-                  "additionalMetadata": {
-                    "description": "Additional data to pass to server"
                   }
                 }
               }
@@ -835,8 +841,8 @@
               }
             }
           },
-          "200": {
-            "description": "successful operation",
+          "404": {
+            "description": "Order not found",
             "content": {
               "application/xml": {
                 "schema": {
@@ -850,8 +856,8 @@
               }
             }
           },
-          "404": {
-            "description": "Order not found",
+          "200": {
+            "description": "successful operation",
             "content": {
               "application/xml": {
                 "schema": {
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app68-3.json b/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app68-3.json
@@ -331,6 +331,15 @@
               "type": "integer",
               "format": "int64"
             }
+          },
+          {
+            "name": "additionalMetadata",
+            "in": "query",
+            "description": "Additional data to pass to server",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -346,9 +355,6 @@
                     "type": "string",
                     "description": "file detail",
                     "format": "binary"
-                  },
-                  "additionalMetadata": {
-                    "description": "Additional data to pass to server"
                   }
                 }
               }
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/3.1.0/app2.json b/springdoc-openapi-webmvc-core/src/test/resources/results/3.1.0/app2.json
@@ -631,6 +631,15 @@
               "type": "integer",
               "format": "int64"
             }
+          },
+          {
+            "name": "additionalMetadata",
+            "in": "query",
+            "description": "Additional data to pass to server",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -643,9 +652,6 @@
                     "type": "string",
                     "format": "binary",
                     "description": "file detail"
-                  },
-                  "additionalMetadata": {
-                    "description": "Additional data to pass to server"
                   }
                 },
                 "required": [

Original file line number	Diff line number	Diff line change
`@@ -495,8 +495,8 @@`
`495`	`495`	`}`
`496`	`496`	`}`
`497`	`497`	`},`
`498`		`- "404": {`
`499`		`- "description": "Pet not found",`
	`498`	`+ "200": {`
	`499`	`+ "description": "successful operation",`
`500`	`500`	`"content": {`
`501`	`501`	`"application/xml": {`
`502`	`502`	`"schema": {`
`@@ -510,8 +510,8 @@`
`510`	`510`	`}`
`511`	`511`	`}`
`512`	`512`	`},`
`513`		`- "200": {`
`514`		`- "description": "successful operation",`
	`513`	`+ "404": {`
	`514`	`+ "description": "Pet not found",`
`515`	`515`	`"content": {`
`516`	`516`	`"application/xml": {`
`517`	`517`	`"schema": {`
`@@ -670,6 +670,15 @@`
`670`	`670`	`"type": "integer",`
`671`	`671`	`"format": "int64"`
`672`	`672`	`}`
	`673`	`+ },`
	`674`	`+ {`
	`675`	`+ "name": "additionalMetadata",`
	`676`	`+ "in": "query",`
	`677`	`+ "description": "Additional data to pass to server",`
	`678`	`+ "required": false,`
	`679`	`+ "schema": {`
	`680`	`+ "type": "string"`
	`681`	`+ }`
`673`	`682`	`}`
`674`	`683`	`],`
`675`	`684`	`"requestBody": {`
`@@ -686,9 +695,6 @@`
`686`	`695`	`"type": "string",`
`687`	`696`	`"description": "file detail",`
`688`	`697`	`"format": "binary"`
`689`		`- },`
`690`		`- "additionalMetadata": {`
`691`		`- "description": "Additional data to pass to server"`
`692`	`698`	`}`
`693`	`699`	`}`
`694`	`700`	`}`
`@@ -854,8 +860,8 @@`
`854`	`860`	`}`
`855`	`861`	`}`
`856`	`862`	`},`
`857`		`- "404": {`
`858`		`- "description": "Order not found",`
	`863`	`+ "200": {`
	`864`	`+ "description": "successful operation",`
`859`	`865`	`"content": {`
`860`	`866`	`"application/xml": {`
`861`	`867`	`"schema": {`
`@@ -869,8 +875,8 @@`
`869`	`875`	`}`
`870`	`876`	`}`
`871`	`877`	`},`
`872`		`- "200": {`
`873`		`- "description": "successful operation",`
	`878`	`+ "404": {`
	`879`	`+ "description": "Order not found",`
`874`	`880`	`"content": {`
`875`	`881`	`"application/xml": {`
`876`	`882`	`"schema": {`
Original file line number	Diff line number	Diff line change
`@@ -331,6 +331,15 @@`
`331`	`331`	`"type": "integer",`
`332`	`332`	`"format": "int64"`
`333`	`333`	`}`
	`334`	`+ },`
	`335`	`+ {`
	`336`	`+ "name": "additionalMetadata",`
	`337`	`+ "in": "query",`
	`338`	`+ "description": "Additional data to pass to server",`
	`339`	`+ "required": false,`
	`340`	`+ "schema": {`
	`341`	`+ "type": "string"`
	`342`	`+ }`
`334`	`343`	`}`
`335`	`344`	`],`
`336`	`345`	`"requestBody": {`
`@@ -346,9 +355,6 @@`
`346`	`355`	`"type": "string",`
`347`	`356`	`"description": "file detail",`
`348`	`357`	`"format": "binary"`
`349`		`- },`
`350`		`- "additionalMetadata": {`
`351`		`- "description": "Additional data to pass to server"`
`352`	`358`	`}`
`353`	`359`	`}`
`354`	`360`	`}`
Original file line number	Diff line number	Diff line change
`@@ -655,6 +655,15 @@`
`655`	`655`	`"type": "integer",`
`656`	`656`	`"format": "int64"`
`657`	`657`	`}`
	`658`	`+ },`
	`659`	`+ {`
	`660`	`+ "name": "additionalMetadata",`
	`661`	`+ "in": "query",`
	`662`	`+ "description": "Additional data to pass to server",`
	`663`	`+ "required": false,`
	`664`	`+ "schema": {`
	`665`	`+ "type": "string"`
	`666`	`+ }`
`658`	`667`	`}`
`659`	`668`	`],`
`660`	`669`	`"requestBody": {`
`@@ -670,9 +679,6 @@`
`670`	`679`	`"type": "string",`
`671`	`680`	`"description": "file detail",`
`672`	`681`	`"format": "binary"`
`673`		`- },`
`674`		`- "additionalMetadata": {`
`675`		`- "description": "Additional data to pass to server"`
`676`	`682`	`}`
`677`	`683`	`}`
`678`	`684`	`}`
`@@ -835,8 +841,8 @@`
`835`	`841`	`}`
`836`	`842`	`}`
`837`	`843`	`},`
`838`		`- "200": {`
`839`		`- "description": "successful operation",`
	`844`	`+ "404": {`
	`845`	`+ "description": "Order not found",`
`840`	`846`	`"content": {`
`841`	`847`	`"application/xml": {`
`842`	`848`	`"schema": {`
`@@ -850,8 +856,8 @@`
`850`	`856`	`}`
`851`	`857`	`}`
`852`	`858`	`},`
`853`		`- "404": {`
`854`		`- "description": "Order not found",`
	`859`	`+ "200": {`
	`860`	`+ "description": "successful operation",`
`855`	`861`	`"content": {`
`856`	`862`	`"application/xml": {`
`857`	`863`	`"schema": {`