Merge branch 'master' into master

Author: gracekarina

README.md

@@ -1,15 +1,15 @@
-# Swagger Parser
+# Swagger Parser <img src="https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SW-logo-clr.png" height="50" align="right">
 
-**NOTE:** If you're looking for `swagger-parser` 1.X and OpenApi 2.0, please refer to [v1 branch](https://github.com/swagger-api/swagger-parser/tree/v1)
+**NOTE:** If you're looking for `swagger-parser` 1.X and OpenAPI 2.0, please refer to [v1 branch](https://github.com/swagger-api/swagger-parser/tree/v1)
 
 [![Build Status](https://img.shields.io/jenkins/s/https/jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2.svg)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2)
 
 ## Overview 
-This is the swagger parser project, which reads OpenAPI Specifications into current Java POJOs.  It also provides a simple framework to add additional converters from different formats into the Swagger objects, making the entire toolchain available.
+This is the Swagger Parser project, which reads OpenAPI definitions into current Java POJOs.  It also provides a simple framework to add additional converters from different formats into the Swagger objects, making the entire toolchain available.
 
 
 ### Usage
-Using the swagger-parser is simple.  Once included in your project, you can read a OpenAPI Specification from any location:
+Using the Swagger Parser is simple.  Once included in your project, you can read a OpenAPI Specification from any location:
 
 ```java
 import io.swagger.v3.parser.OpenAPIV3Parser;
@@ -59,7 +59,7 @@ Manager.  That's done by setting a system environment variable as such:
 export TRUST_ALL=true
 ```
 
-And then the swagger-parser will _ignore_ invalid certificates.  Of course this is generally a bad idea, but if you're 
+And then the Swagger Parser will _ignore_ invalid certificates.  Of course this is generally a bad idea, but if you're 
 working inside a firewall or really know what you're doing, well, there's your rope.
 
 ### Dealing with Let's Encrypt
@@ -99,27 +99,15 @@ You can include this library from Sonatype OSS for SNAPSHOTS, or Maven central f
 <dependency>
   <groupId>io.swagger.parser.v3</groupId>
   <artifactId>swagger-parser</artifactId>
-  <version>2.0.8-SNAPSHOT</version>
+  <version>2.0.10-SNAPSHOT</version>
 </dependency>
-
-```
-
-or
-
-```xml
-<dependency>
-  <groupId>io.swagger.parser.v3</groupId>
-  <artifactId>swagger-parser</artifactId>
-  <version>2.0.8-SNAPSHOT</version>
-</dependency>
-
 ```
 
 
 License
 -------
 
-Copyright 2017 SmartBear Software
+Copyright 2018 SmartBear Software
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -132,4 +120,3 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 ---
-<img src="http://swagger.io/wp-content/uploads/2016/02/logo.jpg"/>

modules/swagger-parser-core/pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <groupId>io.swagger.parser.v3</groupId>
         <artifactId>swagger-parser-project</artifactId>
-        <version>2.0.8-SNAPSHOT</version>
+        <version>2.0.10-SNAPSHOT</version>
         <relativePath>../..</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

modules/swagger-parser-v2-converter/pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <groupId>io.swagger.parser.v3</groupId>
         <artifactId>swagger-parser-project</artifactId>
-        <version>2.0.8-SNAPSHOT</version>
+        <version>2.0.10-SNAPSHOT</version>
         <relativePath>../..</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

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

@@ -139,6 +139,10 @@ public SwaggerParseResult convert(SwaggerDeserializationResult parse) {
 
         Swagger swagger = parse.getSwagger();
 
+        if (swagger.getVendorExtensions() != null) {
+            openAPI.setExtensions(convert(swagger.getVendorExtensions()));
+        }
+
         if (swagger.getExternalDocs() != null) {
             openAPI.setExternalDocs(convert(swagger.getExternalDocs()));
         }
@@ -1056,7 +1060,7 @@ public Parameter convert(io.swagger.models.parameters.Parameter v2Parameter) {
 
                 schema = a;
             } else {
-                schema = new Schema();
+                schema = SchemaTypeUtil.createSchema(sp.getType(), sp.getFormat());
                 schema.setType(sp.getType());
                 schema.setFormat(sp.getFormat());
 

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

@@ -8,6 +8,7 @@
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.ComposedSchema;
+import io.swagger.v3.oas.models.media.IntegerSchema;
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.RequestBody;
@@ -88,6 +89,7 @@ public class V2ConverterTest {
     private static final String ISSUE_765_YAML = "issue-765.yaml";
     private static final String ISSUE_768_JSON = "issue-786.json";
     private static final String ISSUE_820_YAML = "issue-820.yaml";
+    private static final String ISSUE_1032_YAML = "issue-1032.yaml";
 
     private static final String API_BATCH_PATH = "/api/batch/";
     private static final String PETS_PATH = "/pets";
@@ -153,6 +155,9 @@ public class V2ConverterTest {
     private static final String ARRAY_VALUES = "[{\"id\":-1,\"name\":\"Marvin the Paranoid Android\"}," +
             "{\"id\":1000000,\"name\":\"Zaphod Beeblebrox\",\"friends\":[15]}]";
     private static final String SCHEMAS_A_REF = "#/components/schemas/A";
+    private static final String UNIX_TIMESTAMP_QUERY_PARAM = "unixTimestampQuery";
+    private static final String INTEGER_TYPE = "integer";
+    private static final String INT64_FORMAT = "int64";
 
     private static final int MAX_LENGTH = 60;
     private static final int REQUIRED_SIZE = 2;
@@ -164,7 +169,7 @@ public class V2ConverterTest {
     private static final int MIN_LENGTH = 3;
     private static final int NUMBER_VALUE_TWENTY = 20;
     private static final double MULTIPLE_OF_VALUE = 0.01D;
-    private static final long DEFAULT_VALUE = 11L;
+    private static final int DEFAULT_VALUE = 11;
     private static final int EXAMPLE_8_NUMBER = 8;
     private static final int EXAMPLE_42_NUMBER = 42;
 
@@ -727,6 +732,13 @@ public void testIssue755() throws Exception {
         final OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_755_YAML);
         assertNotNull(oas);
     }
+
+    @Test(description = "OpenAPI v2 converter - top-level extensions should be preserved")
+    public void testTopLevelExtensions() throws Exception {
+        final OpenAPI oas = getConvertedOpenAPIFromJsonFile(PARAMETER_CONVERSION_JSON);
+        assertNotNull(oas);
+        assertEquals((String)oas.getExtensions().get("x-some-extensions"), "hello");
+    }
 
     @Test(description = "OpenAPI v2 converter - Conversion param extensions should be preserved")
     public void testIssue820() throws Exception {
@@ -755,6 +767,19 @@ public void testIssue820() throws Exception {
         assertEquals(baz.getNullable(), Boolean.FALSE);
     }
 
+    @Test(description = "OpenAPI v2 converter - proper IntegerSchema parsing")
+    public void testIssue1032() throws Exception {
+        final OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_1032_YAML);
+        assertNotNull(oas);
+        Parameter unixTimestampQueryParameter = oas.getComponents().getParameters().get(UNIX_TIMESTAMP_QUERY_PARAM);
+        assertNotNull(unixTimestampQueryParameter);
+        Schema s = unixTimestampQueryParameter.getSchema();
+        assertTrue((s instanceof IntegerSchema), "actual type: " + s);
+        IntegerSchema integerSchema = (IntegerSchema) s;
+        assertEquals(INTEGER_TYPE, integerSchema.getType());
+        assertEquals(INT64_FORMAT, integerSchema.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())));
@@ -764,4 +789,4 @@ private OpenAPI getConvertedOpenAPIFromJsonFile(String file) throws IOException,
         assertNotNull(result);
         return result.getOpenAPI();
     }
-}
+}

modules/swagger-parser-v2-converter/src/test/resources/issue-1032.yaml

@@ -0,0 +1,27 @@
+swagger: '2.0'
+basePath: "/"
+info:
+  version: "1"
+  title: "x"
+
+schemes:
+- https
+consumes:
+- application/json
+produces:
+- application/json
+paths:
+  /data:
+    get:
+      operationId: "getData"
+      parameters:
+      - $ref: '#/parameters/unixTimestampQuery'
+      responses:
+        '403':
+          description: Forbidden
+parameters:
+  unixTimestampQuery:
+    in: query
+    name: unixTimestamp
+    type: integer
+    format: int64

modules/swagger-parser-v2-converter/src/test/resources/parameter-conversion.json

@@ -1,5 +1,6 @@
 {
     "swagger": "2.0",
+    "x-some-extensions": "hello",
     "info": {
         "version": "1.0",
         "title": "x-example"

modules/swagger-parser-v3/pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <groupId>io.swagger.parser.v3</groupId>
         <artifactId>swagger-parser-project</artifactId>
-        <version>2.0.8-SNAPSHOT</version>
+        <version>2.0.10-SNAPSHOT</version>
         <relativePath>../..</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/ResolverCache.java

@@ -4,6 +4,7 @@
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.parser.core.models.AuthorizationValue;
 import io.swagger.v3.parser.models.RefFormat;
@@ -165,6 +166,12 @@ protected <T> void updateLocalRefs(String file, T result) {
                 }
             }
         }
+        if(result instanceof Parameter){
+            Parameter parameter = (Parameter)result;
+            if (parameter.getSchema() != null){
+                updateLocalRefs(file,parameter.getSchema());
+            }
+        }
         if(result instanceof Schema && ((Schema)(result)).get$ref() != null) {
             Schema prop = (Schema) result;
             updateLocalRefs(file, prop);
@@ -194,11 +201,12 @@ protected String merge(String host, String ref) {
         if(StringUtils.isBlank(host)) {
             return ref;
         }
+
         if(ref.startsWith("http:") || ref.startsWith("https:")) {
             // already an absolute ref
             return ref;
         }
-        if(!host.startsWith("http:") && !host.startsWith("https:")) {
+        if(!host.startsWith("http:") && !host.startsWith("https:") && !ref.startsWith("#/components")) {
             return ref;
         }
         if(ref.startsWith(".")) {

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/processors/ExternalRefProcessor.java

@@ -20,15 +20,20 @@
 import io.swagger.v3.parser.ResolverCache;
 import io.swagger.v3.parser.models.RefFormat;
 import io.swagger.v3.parser.models.RefType;
+import io.swagger.v3.parser.util.RefUtils;
+
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.LoggerFactory;
 
 import java.net.URI;
+import java.util.Collection;
 import java.util.LinkedHashMap;
 import java.util.Map;
+import java.util.Objects;
 
 import static io.swagger.v3.parser.util.RefUtils.computeDefinitionName;
 import static io.swagger.v3.parser.util.RefUtils.computeRefFormat;
+import static io.swagger.v3.parser.util.RefUtils.getExternalPath;
 import static io.swagger.v3.parser.util.RefUtils.isAnExternalRefFormat;
 
 public final class ExternalRefProcessor {
@@ -177,37 +182,40 @@ public String processRefToExternalSchema(String $ref, RefFormat refFormat) {
         return newRef;
     }
 
-    private void processProperties(Map<String,Schema> subProps, String file) {
-        if (subProps != null) {
-            for (Map.Entry<String, Schema> prop : subProps.entrySet()) {
-                if (prop.getValue().get$ref() != null) {
-                    processRefSchema(prop.getValue(), file);
-                } else if (prop.getValue() instanceof ArraySchema) {
-                    ArraySchema arrayProp = (ArraySchema) prop.getValue();
-                    if (arrayProp.getItems() != null && arrayProp.getItems().get$ref() != null &&
-                            StringUtils.isNotBlank(arrayProp.getItems().get$ref())) {
-                        processRefSchema(arrayProp.getItems(), file);
-                    }
-                    if (arrayProp.getItems() != null && arrayProp.getItems().getProperties() != null ) {
-                        processProperties(arrayProp.getItems().getProperties(), file);
-                    }
-                } else if (prop.getValue().getAdditionalProperties() != null && prop.getValue().getAdditionalProperties() instanceof Schema) {
-                    Schema mapProp =  (Schema) prop.getValue().getAdditionalProperties();
-                    if (mapProp.get$ref() != null) {
-                        processRefSchema(mapProp, file);
-                    } else if (mapProp.getAdditionalProperties() instanceof ArraySchema &&
-                            ((ArraySchema) mapProp.getAdditionalProperties()).getItems()!= null &&
-                            ((ArraySchema) mapProp.getAdditionalProperties()).getItems().get$ref() != null
-                            && StringUtils.isNotBlank(((ArraySchema) mapProp.getAdditionalProperties()).getItems().get$ref())) {
-                        processRefSchema(((ArraySchema) mapProp.getAdditionalProperties()).getItems(), file);
-                    }
-                }else if (prop.getValue() instanceof ObjectSchema){
-                    ObjectSchema objProp = (ObjectSchema) prop.getValue();
-                    if(objProp.getProperties() != null ){
-                        processProperties(objProp.getProperties(),file);
-                    }
-                }
+    private void processProperty(Schema property, String file) {
+        if (property != null) {
+            if (StringUtils.isNotBlank(property.get$ref())) {
+                processRefSchema(property, file);
             }
+            if (property.getProperties() != null) {
+                processProperties(property.getProperties(), file);
+            }
+            if (property instanceof ArraySchema) {
+                processProperty(((ArraySchema) property).getItems(), file);
+            }
+            if (property.getAdditionalProperties() instanceof Schema) {
+                processProperty(((Schema) property.getAdditionalProperties()), file);
+            }
+            if (property instanceof ComposedSchema) {
+                ComposedSchema composed = (ComposedSchema) property;
+                processProperties(composed.getAllOf(), file);
+                processProperties(composed.getAnyOf(), file);
+                processProperties(composed.getOneOf(), file);
+            }
+        }
+    }
+
+    private void processProperties(Collection<Schema> properties, String file) {
+        if (properties != null) {
+            for (Schema property : properties) {
+                processProperty(property, file);
+            }
+        }
+    }
+
+    private void processProperties(Map<String, Schema> properties, String file) {
+        if (properties != null) {
+            processProperties(properties.values(), file);
         }
     }
 
@@ -685,8 +693,10 @@ private void processRefSchema(Schema subRef, String externalFile) {
             return;
         }
         String $ref = subRef.get$ref();
+        String subRefExternalPath = getExternalPath(subRef.get$ref())
+            .orElse(null);
 
-        if (format.equals(RefFormat.RELATIVE)) {
+        if (format.equals(RefFormat.RELATIVE) && !Objects.equals(subRefExternalPath, externalFile)) {
             $ref = constructRef(subRef, externalFile);
             subRef.set$ref($ref);
         }else {