Merge pull request #2 from swagger-api/master

Sync to base

Author: kerrykimbrough

README.md

@@ -2,7 +2,11 @@
 
 **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)
+[![Build Status](https://img.shields.io/jenkins/build.svg?jobUrl=https://jenkins.swagger.io/job/oss-swagger-parser-v2/)](https://jenkins.swagger.io/job/oss-swagger-parser-v2/)
+
+[![Build Status](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2/badge/icon?subject=jenkins%20build%20-%20java%208)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2/)
+
+[![Build Status](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2-java9/badge/icon?subject=jenkins%20build%20-%20java%209)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2-java9/)
 
 ## Overview 
 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.
@@ -99,10 +103,13 @@ 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.12</version>
+  <version>2.0.16</version>
 </dependency>
 ```
 
+## Security contact
+
+Please disclose any security-related issues or vulnerabilities by emailing [[email protected]](mailto:[email protected]), instead of using the public issue tracker.
 
 License
 -------

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.13-SNAPSHOT</version>
+        <version>2.0.17-SNAPSHOT</version>
         <relativePath>../..</relativePath>
     </parent>
     <modelVersion>4.0.0</modelVersion>

modules/swagger-parser-core/src/main/java/io/swagger/v3/parser/core/models/AuthorizationValue.java

@@ -1,15 +1,26 @@
 package io.swagger.v3.parser.core.models;
 
+import java.net.URL;
+import java.util.Objects;
+import java.util.function.Predicate;
+
+
 public class AuthorizationValue {
     private String value, type, keyName;
+    private Predicate<URL> urlMatcher;
 
     public AuthorizationValue() {
     }
 
-    public AuthorizationValue(String keyName, String value, String type) {
+    public AuthorizationValue(String keyName, String value, String type, Predicate<URL> urlMatcher) {
         this.setKeyName(keyName);
         this.setValue(value);
         this.setType(type);
+        this.setUrlMatcher(urlMatcher);
+    }
+
+    public AuthorizationValue(String keyName, String value, String type) {
+        this(keyName, value, type, url -> true);
     }
 
     public AuthorizationValue value(String value) {
@@ -27,6 +38,11 @@ public AuthorizationValue keyName(String keyName) {
         return this;
     }
 
+    public AuthorizationValue urlMatcher(Predicate<URL> urlMatcher) {
+        setUrlMatcher(urlMatcher);
+        return this;
+    }
+
     public String getValue() {
         return value;
     }
@@ -51,13 +67,22 @@ public void setKeyName(String keyName) {
         this.keyName = keyName;
     }
 
+    public Predicate<URL> getUrlMatcher() {
+        return urlMatcher;
+    }
+
+    public void setUrlMatcher(Predicate<URL> urlMatcher) {
+        this.urlMatcher = Objects.requireNonNull(urlMatcher);
+    }
+
     @Override
     public int hashCode() {
         final int prime = 31;
         int result = 1;
         result = prime * result + ((keyName == null) ? 0 : keyName.hashCode());
         result = prime * result + ((type == null) ? 0 : type.hashCode());
         result = prime * result + ((value == null) ? 0 : value.hashCode());
+        result = prime * result + urlMatcher.hashCode();
         return result;
     }
 
@@ -94,6 +119,9 @@ public boolean equals(Object obj) {
         } else if (!value.equals(other.value)) {
             return false;
         }
+        if (!urlMatcher.equals(other.urlMatcher)) {
+            return false;
+        }
         return true;
     }
 }

modules/swagger-parser-core/src/main/java/io/swagger/v3/parser/core/models/ParseOptions.java

@@ -5,6 +5,7 @@ public class ParseOptions {
     private boolean resolveCombinators = true;
     private boolean resolveFully;
     private boolean flatten;
+    private boolean skipMatches;
 
     public boolean isResolve() {
         return resolve;
@@ -33,4 +34,12 @@ public void setResolveFully(boolean resolveFully) {
     public boolean isFlatten() { return flatten; }
 
     public void setFlatten(boolean flatten) { this.flatten = flatten; }
+
+    public boolean isSkipMatches() {
+        return skipMatches;
+    }
+
+    public void setSkipMatches(boolean skipMatches) {
+        this.skipMatches = skipMatches;
+    }
 }

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.13-SNAPSHOT</version>
+        <version>2.0.17-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

@@ -32,6 +32,8 @@
 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.core.util.Yaml;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.ExternalDocumentation;
 import io.swagger.v3.oas.models.OpenAPI;
@@ -59,6 +61,7 @@
 import io.swagger.v3.oas.models.security.SecurityScheme;
 import io.swagger.v3.oas.models.servers.Server;
 import io.swagger.v3.oas.models.tags.Tag;
+import io.swagger.v3.parser.OpenAPIV3Parser;
 import io.swagger.v3.parser.core.extensions.SwaggerParserExtension;
 import io.swagger.v3.parser.core.models.AuthorizationValue;
 import io.swagger.v3.parser.core.models.ParseOptions;
@@ -106,7 +109,23 @@ public SwaggerParseResult readContents(String swaggerAsString, List<Authorizatio
                 result.setSwagger(resolved);
             }
         }
-        return convert(result);
+        SwaggerParseResult out = convert(result);
+        if (out != null && options != null && options.isFlatten()) {
+            try {
+                SwaggerParseResult resultV3 = new OpenAPIV3Parser().readContents(Yaml.pretty(out.getOpenAPI()), auth, options);
+                out.setOpenAPI(resultV3.getOpenAPI());
+                if (out.getMessages() != null) {
+                    out.getMessages().addAll(resultV3.getMessages());
+                    out.messages(out.getMessages().stream()
+                            .distinct()
+                            .collect(Collectors.toList()));
+                } else {
+                    out.messages(resultV3.getMessages());
+                }
+            } catch (Exception ignore) {}
+        }
+        return out;
+
     }
 
     public List<io.swagger.models.auth.AuthorizationValue> convert(List<AuthorizationValue> auths) {
@@ -420,7 +439,7 @@ private List<Server> convert(List<Scheme> schemes, String host, String basePath)
                 servers.add(server);
             }
         } else {
-            if (!"/".equals(baseUrl)) {
+            if (!StringUtils.startsWith(baseUrl, "/") && !"/".equals(baseUrl)) {
                 baseUrl = "//" + baseUrl;
             }
             Server server = new Server();
@@ -555,6 +574,7 @@ public Operation convert(io.swagger.models.Operation v2Operation) {
         }
         operation.setDeprecated(v2Operation.isDeprecated());
         operation.setOperationId(v2Operation.getOperationId());
+        operation.setExtensions(convert(v2Operation.getVendorExtensions()));
 
         operation.setTags(v2Operation.getTags());
 
@@ -566,6 +586,7 @@ public Operation convert(io.swagger.models.Operation v2Operation) {
                     formParams.add(param);
                 } else if ("body".equals(param.getIn())) {
                     operation.setRequestBody(convertParameterToRequestBody(param, v2Operation.getConsumes()));
+                    operation.addExtension("x-codegen-request-body-name", param.getName());
                 } else {
                     Parameter convert = convert(param);
                     String $ref = convert.get$ref();
@@ -612,8 +633,6 @@ public Operation convert(io.swagger.models.Operation v2Operation) {
             operation.setSecurity(convertSecurityRequirementsMap(v2Operation.getSecurity()));
         }
 
-        operation.setExtensions(convert(v2Operation.getVendorExtensions()));
-
         return operation;
     }
 
@@ -692,9 +711,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());
@@ -1142,6 +1172,9 @@ public Schema convert(io.swagger.models.Model v2Model) {
             composed.setTitle(composedModel.getTitle());
             composed.setExtensions(convert(composedModel.getVendorExtensions()));
             composed.setAllOf(composedModel.getAllOf().stream().map(this::convert).collect(Collectors.toList()));
+
+            addProperties(v2Model, composed);
+
             result = composed;
         } else {
             String v2discriminator = null;
@@ -1155,14 +1188,7 @@ public Schema convert(io.swagger.models.Model v2Model) {
 
             result = Json.mapper().convertValue(v2Model, Schema.class);
 
-            if ((v2Model.getProperties() != null) && (v2Model.getProperties().size() > 0)) {
-                Map<String, Property> properties = v2Model.getProperties();
-
-                properties.forEach((k, v) -> {
-                    result.addProperties(k, convert(v));
-                });
-
-            }
+            addProperties(v2Model, result);
 
             if (v2Model instanceof ModelImpl) {
                 ModelImpl model = (ModelImpl) v2Model;
@@ -1195,5 +1221,16 @@ public Schema convert(io.swagger.models.Model v2Model) {
 
         return result;
     }
+
+    private void addProperties(Model v2Model, Schema schema) {
+        if ((v2Model.getProperties() != null) && (v2Model.getProperties().size() > 0)) {
+            Map<String, Property> properties = v2Model.getProperties();
+
+            properties.forEach((k, v) -> {
+                schema.addProperties(k, convert(v));
+            });
+
+        }
+    }
 }
 

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;
@@ -90,6 +92,8 @@ public class V2ConverterTest {
     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 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";
@@ -674,8 +678,15 @@ public void testIssue758() throws Exception {
     public void testIssue762() throws Exception {
         final OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_762_JSON);
         assertNotNull(oas);
-    } 
-  
+    }
+
+    @Test(description = "OpenAPI v2 Converter: Ensure body name is preserved in x-codegen-request-body-name extension")
+    public void testPreserveBodyParameterName() throws Exception {
+        final OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_762_JSON);
+        assertNotNull(oas);
+        assertEquals(oas.getPaths().get("/").getPut().getExtensions().get("x-codegen-request-body-name"), "pet");
+    }
+
     @Test(description = "requestBody not correctly populated when Parameters is a list of $refs (OAS 2 to 3 conversion)")
     public void testIssue765() throws Exception {
         final OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_765_YAML);
@@ -779,7 +790,47 @@ public void testIssue1032() throws Exception {
         assertEquals(INTEGER_TYPE, integerSchema.getType());
         assertEquals(INT64_FORMAT, integerSchema.getFormat());
     }
-    
+
+    @Test(description = "OpenAPI v2 converter - converts URL correctly when it begins with forward slash")
+    public void testIssue1113() throws Exception {
+        final OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_1113_YAML);
+        assertNotNull(oas);
+        assertNotNull(oas.getServers());
+        assertFalse(oas.getServers().isEmpty());
+        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())));

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

@@ -0,0 +1,14 @@
+swagger: '2.0'
+info:
+  title: Test for Issue 1113
+  version: 1.0.0
+basePath: /test
+paths:
+  /ping:
+    get:
+      summary: test
+      description: 'test'
+      operationId: pingOp
+      responses:
+        '200':
+          description: OK