Merge pull request #2 from swagger-api/master

scottr-ad · web-flow · commit 8152ae457c40 · 2019-08-20T15:54:49.000+10:00
Pull changes from master
diff --git a/modules/swagger-parser-v2-converter/src/main/java/io/swagger/v3/parser/converter/SwaggerConverter.java b/modules/swagger-parser-v2-converter/src/main/java/io/swagger/v3/parser/converter/SwaggerConverter.java
@@ -32,6 +32,7 @@
 import io.swagger.parser.SwaggerResolver;
 import io.swagger.parser.util.SwaggerDeserializationResult;
 import io.swagger.v3.core.util.Json;
+import io.swagger.v3.core.util.PrimitiveType;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.ExternalDocumentation;
 import io.swagger.v3.oas.models.OpenAPI;
@@ -692,9 +693,20 @@ private Schema convert(SerializableParameter sp) {
             }
             schema = as;
         } else {
-            schema = new Schema();
-            schema.setType(sp.getType());
-            schema.setFormat(sp.getFormat());
+            PrimitiveType ptype = PrimitiveType.fromTypeAndFormat(sp.getType(), sp.getFormat());
+            if (ptype != null) {
+                schema = ptype.createProperty();
+            } else {
+                ptype = PrimitiveType.fromTypeAndFormat(sp.getType(), null);
+                if (ptype != null) {
+                    schema = ptype.createProperty();
+                    schema.setFormat(sp.getFormat());
+                } else {
+                    schema = new Schema();
+                    schema.setType(sp.getType());
+                    schema.setFormat(sp.getFormat());
+                }
+            }
         }
 
         schema.setDescription(sp.getDescription());
diff --git a/modules/swagger-parser-v2-converter/src/test/java/io/swagger/parser/test/V2ConverterTest.java b/modules/swagger-parser-v2-converter/src/test/java/io/swagger/parser/test/V2ConverterTest.java
@@ -7,8 +7,10 @@
 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.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.RequestBody;
@@ -91,6 +93,7 @@ public class V2ConverterTest {
     private static final String ISSUE_820_YAML = "issue-820.yaml";
     private static final String ISSUE_1032_YAML = "issue-1032.yaml";
     private static final String ISSUE_1113_YAML = "issue-1113.yaml";
+    private static final String ISSUE_1164_YAML = "issue-1164.yaml";
 
     private static final String API_BATCH_PATH = "/api/batch/";
     private static final String PETS_PATH = "/pets";
@@ -790,7 +793,37 @@ public void testIssue1113() throws Exception {
         assertNotNull(oas.getServers().get(0));
         assertEquals(oas.getServers().get(0).getUrl(), "/test");
     }
-    
+
+    @Test(description = "OpenAPI v2 converter - uses specialized schema subclasses where available")
+    public void testIssue1164() throws Exception {
+        final OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_1164_YAML);
+        assertNotNull(oas);
+        assertNotNull(oas.getPaths());
+        assertNotNull(oas.getPaths().get("/foo"));
+        assertNotNull(oas.getPaths().get("/foo").getGet());
+        assertNotNull(oas.getPaths().get("/foo").getGet().getRequestBody());
+        assertNotNull(oas.getPaths().get("/foo").getGet().getRequestBody().getContent());
+        assertNotNull(oas.getPaths().get("/foo").getGet().getRequestBody().getContent().get("multipart/form-data"));
+        Schema formSchema = oas.getPaths().get("/foo").getGet().getRequestBody().getContent().get("multipart/form-data").getSchema();
+        assertNotNull(formSchema);
+        assertNotNull(formSchema.getProperties());
+        assertEquals(4, formSchema.getProperties().size());
+        assertTrue(formSchema.getProperties().get("first") instanceof StringSchema);
+
+        assertTrue(formSchema.getProperties().get("second") instanceof BooleanSchema);
+
+        assertTrue(formSchema.getProperties().get("third") instanceof StringSchema);
+        StringSchema third = (StringSchema) formSchema.getProperties().get("third");
+        assertNotNull(third.getFormat());
+        assertTrue("password".equals(third.getFormat()));
+
+        assertTrue(formSchema.getProperties().get("fourth") instanceof BooleanSchema);
+        Schema fourth = (Schema) formSchema.getProperties().get("fourth");
+        assertNotNull(fourth.getType());
+        assertNotNull(fourth.getFormat());
+        assertTrue("completely-custom".equals(fourth.getFormat()));
+    }
+
     private OpenAPI getConvertedOpenAPIFromJsonFile(String file) throws IOException, URISyntaxException {
         SwaggerConverter converter = new SwaggerConverter();
         String swaggerAsString = new String(Files.readAllBytes(Paths.get(getClass().getClassLoader().getResource(file).toURI())));
diff --git a/modules/swagger-parser-v2-converter/src/test/resources/issue-1164.yaml b/modules/swagger-parser-v2-converter/src/test/resources/issue-1164.yaml
@@ -0,0 +1,30 @@
+swagger: '2.0'
+info:
+  title: Test for Issue 1164
+  version: 1.0.0
+paths:
+  /foo:
+    get:
+      operationId: doFoo
+      parameters:
+        - in: formData
+          name: first
+          type: string
+          required: true
+        - in: formData
+          name: second
+          type: boolean
+          required: true
+        - in: formData
+          name: third
+          type: string
+          format: password
+          required: true
+        - in: formData
+          name: fourth
+          type: boolean
+          format: completely-custom
+          required: true
+      responses:
+        '200':
+          description: OK
diff --git a/modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java b/modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java
@@ -546,7 +546,7 @@ public Paths getPaths(ObjectNode obj, String location, ParseResult result) {
                     }
                     ObjectNode path = (ObjectNode) pathValue;
                     PathItem pathObj = getPathItem(path,String.format("%s.'%s'", location,pathName), result);
-                    String[] eachPart = pathName.split("/");
+                    String[] eachPart = pathName.split("[-/.]+");
                     Arrays.stream(eachPart)
                             .filter(part -> part.startsWith("{") && part.endsWith("}") && part.length() > 2)
                             .forEach(part -> {
diff --git a/modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIV3ParserTest.java b/modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIV3ParserTest.java
@@ -67,6 +67,16 @@ public class OpenAPIV3ParserTest {
     protected WireMockServer wireMockServer;
 
 
+    @Test
+    public void testIssue1169() {
+        ParseOptions options = new ParseOptions();
+        options.setResolve(true);
+        SwaggerParseResult parseResult = new OpenAPIV3Parser().readLocation("issue1169.yaml", null, options);
+        assertTrue(parseResult.getMessages().size() == 0);
+        OpenAPI apispec = parseResult.getOpenAPI();
+        assertNotNull(apispec);
+    }
+
 
     @Test
     public void testIssue339() throws Exception {
diff --git a/modules/swagger-parser-v3/src/test/resources/issue1169.yaml b/modules/swagger-parser-v3/src/test/resources/issue1169.yaml
@@ -0,0 +1,83 @@
+---
+openapi: 3.0.0
+servers:
+  - description: Production
+    url: https://apps.gov.bc.ca/pub/bcgnws
+  - description: Test
+    url: https://test.apps.gov.bc.ca/pub/bcgnws
+  - description: Delivery
+    url: https://delivery.apps.gov.bc.ca/pub/bcgnws
+info:
+  contact:
+    email: geographical.names@gov.bc.ca
+    name: BC Geographical Names Office
+    url: https://www2.gov.bc.ca/gov/content?id=A3C60F17CE934B1ABFA366F28C66E370
+  description: "This REST API provides searchable access to information about geographical
+    names in the province of British Columbia, including name status and details about
+    the corresponding geographic feature. \n\nPlease note that you may experience
+    issues when submitting requests to the delivery or test environment if using this
+    [OpenAPI specification](https://github.com/bcgov/api-specs) in other API console
+    viewers."
+  license:
+    name: Crown Copyright
+    url: https://www2.gov.bc.ca/gov/content?id=1AAACC9C65754E4D89A118B875E0FBDA
+  title: BC Geographical Names Web Service -
+  version: 3.x.x
+  x-apisguru-categories:
+    - open_data
+  x-logo:
+    url: https://api.apis.guru/v2/cache/logo/https_avatars1.githubusercontent.com_u_916280.jpeg
+  x-origin:
+    - converter:
+        url: https://github.com/lucybot/api-spec-converter
+        version: 2.7.31
+      format: openapi
+      url: https://raw.githubusercontent.com/bcgov/api-specs/master/bcgnws/bcgnws.json
+      version: '3.0'
+  x-preferred: true
+  x-providerName: gov.bc.ca
+  x-serviceName: bcgnws
+tags:
+  - name: search
+  - name: name
+  - name: feature
+  - name: feature taxonomy
+  - name: name authority
+paths:
+  "/names/{nameId}.{outputFormat}":
+    get:
+      description: Get information about the geographical name with the specified
+        nameId.
+      parameters:
+        - description: The unique identifier for a name
+          example: 22474
+          in: path
+          name: nameId
+          required: true
+          schema:
+            type: integer
+        - description: The format of the output.
+          example: json
+          in: path
+          name: outputFormat
+          required: true
+          schema:
+            default: json
+            enum:
+              - json
+              - xml
+              - kml
+              - csv
+              - html
+            type: string
+      responses:
+        '200':
+          description: Information about the name with the specified nameId
+        '404':
+          description: The name with the given nameId doesn't exist, or the output
+            format is invalid.
+      summary: Get a name by its nameId
+      tags:
+        - name
+components:
+  schemas: {}
diff --git a/pom.xml b/pom.xml
@@ -287,7 +287,7 @@
     <properties>
         <swagger-parser-v2-version>1.0.46-SNAPSHOT</swagger-parser-v2-version>
         <commons-io-version>2.4</commons-io-version>
-        <slf4j-version>1.6.3</slf4j-version>
+        <slf4j-version>1.7.28</slf4j-version>
         <swagger-core-version>2.0.9-SNAPSHOT</swagger-core-version>
         <junit-version>4.8.1</junit-version>
         <testng-version>6.14.2</testng-version>

Original file line number	Diff line number	Diff line change
`@@ -546,7 +546,7 @@ public Paths getPaths(ObjectNode obj, String location, ParseResult result) {`
`546`	`546`	`}`
`547`	`547`	`ObjectNode path = (ObjectNode) pathValue;`
`548`	`548`	`PathItem pathObj = getPathItem(path,String.format("%s.'%s'", location,pathName), result);`
`549`		`- String[] eachPart = pathName.split("/");`
	`549`	`+ String[] eachPart = pathName.split("[-/.]+");`
`550`	`550`	`Arrays.stream(eachPart)`
`551`	`551`	`.filter(part -> part.startsWith("{") && part.endsWith("}") && part.length() > 2)`
`552`	`552`	`.forEach(part -> {`