Merge pull request #1713 from RockyMM/master

Changes form-data schema to ObjectSchema

Author: gracekarina

modules/swagger-parser-v2-converter/src/main/java/io/swagger/v3/parser/converter/SwaggerConverter.java

@@ -37,13 +37,7 @@
 import io.swagger.v3.oas.models.info.Contact;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.info.License;
-import io.swagger.v3.oas.models.media.ArraySchema;
-import io.swagger.v3.oas.models.media.ComposedSchema;
-import io.swagger.v3.oas.models.media.Content;
-import io.swagger.v3.oas.models.media.Discriminator;
-import io.swagger.v3.oas.models.media.FileSchema;
-import io.swagger.v3.oas.models.media.MediaType;
-import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.media.*;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.RequestBody;
 import io.swagger.v3.oas.models.responses.ApiResponse;
@@ -66,7 +60,6 @@
 
 import java.math.BigDecimal;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -679,7 +672,7 @@ private Schema convertFormDataToSchema(io.swagger.models.parameters.Parameter fo
     private RequestBody convertFormDataToRequestBody(List<io.swagger.models.parameters.Parameter> formParams, List<String> consumes) {
         RequestBody body = new RequestBody();
 
-        Schema formSchema = new Schema();
+        Schema<Object> formSchema = new ObjectSchema();
 
         for (io.swagger.models.parameters.Parameter param : formParams) {
             SerializableParameter sp;
@@ -702,7 +695,7 @@ private RequestBody convertFormDataToRequestBody(List<io.swagger.models.paramete
                 formSchema.addRequiredItem(sp.getName());
             }
 
-            formSchema.addProperties(name, schema);
+            formSchema.addProperty(name, schema);
         }
 
         List<String> mediaTypes = new ArrayList<>(globalConsumes);

modules/swagger-parser-v2-converter/src/test/java/io/swagger/parser/test/V2ConverterTest.java

@@ -7,12 +7,7 @@
 import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.headers.Header;
 import io.swagger.v3.oas.models.info.Info;
-import io.swagger.v3.oas.models.media.ArraySchema;
-import io.swagger.v3.oas.models.media.BooleanSchema;
-import io.swagger.v3.oas.models.media.ComposedSchema;
-import io.swagger.v3.oas.models.media.IntegerSchema;
-import io.swagger.v3.oas.models.media.StringSchema;
-import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.media.*;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.RequestBody;
 import io.swagger.v3.oas.models.responses.ApiResponse;
@@ -900,4 +895,22 @@ public void testInlineDefinitionProperty() throws Exception {
         assertNotNull(petCategoryInline);
 
     }
+
+    @Test()
+    public void testConvertFormDataAsObjectSchema() throws Exception {
+        OpenAPI oas = getConvertedOpenAPIFromJsonFile("issue-1529.json");
+        assertNotNull(oas);
+
+        Schema companiesSchema = oas.getPaths()
+                                    .get("/companies/")
+                                    .getPost()
+                                    .getRequestBody()
+                                    .getContent()
+                                    .get("multipart/form-data")
+                                    .getSchema();
+
+        assertEquals(companiesSchema.getType(), "object");
+        assertEquals(companiesSchema.getClass(), ObjectSchema.class);
+
+    }
 }

modules/swagger-parser-v2-converter/src/test/resources/issue-1529.json

@@ -0,0 +1,81 @@
+{
+  "basePath": "/external-api/v3",
+  "consumes": [
+    "application/json"
+  ],
+
+  "host": "host.systems",
+  "info": {
+    "description": "test form data",
+    "title": "test form data",
+    "version": "v0"
+  },
+  "paths": {
+    "/companies/": {
+      "post": {
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Create company.",
+        "operationId": "companies_create",
+        "parameters": [
+          {
+            "description": "Accessible extensions are: `.jpg`, `.png`, maximum size is: `5.0` Mb",
+            "in": "formData",
+            "name": "profile_image",
+            "required": true,
+            "type": "file"
+          },
+          {
+            "format": "date",
+            "in": "formData",
+            "name": "expiry",
+            "required": false,
+            "type": "string",
+            "x-nullable": true
+          },
+          {
+            "in": "formData",
+            "maxLength": 250,
+            "minLength": 1,
+            "name": "name",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "description": "Accessible extensions are: `.svg`, `.png`, maximum size is: `5.0` Mb",
+            "in": "formData",
+            "name": "logo",
+            "required": false,
+            "type": "file",
+            "x-nullable": true
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "response",
+            "schema": {
+              "type": "object",
+              "properties": {
+                "status" : {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "summary": "Create company.",
+        "tags": [
+          "companies"
+        ]
+      }
+    }
+  },
+  "produces": [
+    "application/json"
+  ],
+  "schemes": [
+    "http"
+  ],
+  "swagger": "2.0"
+}