Merge branch 'master' into issue-1715

Author: gracekarina

.gitignore

@@ -12,3 +12,4 @@ modules/swagger-parser/src/test/resources/relative-file-references/yaml
 **/test-output/*
 dependency-reduced-pom.xml
 *.pyc
+/bin/

README.md

@@ -261,7 +261,7 @@ components:
       example: Example value
 ```
 
-#### 3. flatten : 
+#### 3. flatten: 
 
 ```java
 ParseOptions parseOptions = new ParseOptions();

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

@@ -12,7 +12,8 @@ public class ParseOptions {
     private boolean validateExternalRefs = false;
     private boolean validateInternalRefs = true;
     private boolean legacyYamlDeserialization = false;
-
+    private boolean resolveRequestBody = false;
+    
     public boolean isResolve() {
         return resolve;
     }
@@ -36,6 +37,19 @@ public boolean isResolveFully() {
     public void setResolveFully(boolean resolveFully) {
         this.resolveFully = resolveFully;
     }
+    
+    public boolean isResolveRequestBody() {
+        return resolveRequestBody;
+    }
+
+    /**
+     * If set to true, will help resolving the requestBody as inline, provided
+     * resolve is also set to true. Default is false because of the existing
+     * behaviour.
+     */
+    public void setResolveRequestBody(boolean resolveRequestBody) {
+        this.resolveRequestBody = resolveRequestBody;
+    }
 
     public boolean isFlatten() { return flatten; }
 

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

@@ -68,12 +68,12 @@ public class ResolverCache {
     private Map<String, String> externalFileCache = new HashMap<>();
     private List<String> referencedModelKeys = new ArrayList<>();
     private Set<String> resolveValidationMessages;
-
     private final ParseOptions parseOptions;
 
 
     /*
-    a map that stores original external references, and their associated renamed references
+     * a map that stores original external references, and their associated renamed
+     * references
      */
     private Map<String, String> renameCache = new HashMap<>();
 
@@ -394,4 +394,8 @@ public Map<String, String> getExternalFileCache() {
     public Map<String, String> getRenameCache() {
         return Collections.unmodifiableMap(renameCache);
     }
+
+    public ParseOptions getParseOptions() {
+        return parseOptions;
+    }
 }

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

@@ -31,7 +31,6 @@ public OperationProcessor(ResolverCache cache, OpenAPI openAPI) {
         this.responseProcessor = new ResponseProcessor(cache,openAPI);
         this.requestBodyProcessor = new RequestBodyProcessor(cache,openAPI);
         this.externalRefProcessor = new ExternalRefProcessor(cache, openAPI);
-
         this.cache = cache;
     }
 
@@ -40,18 +39,30 @@ public void processOperation(Operation operation) {
         if(processedOperationParameters != null) {
             operation.setParameters(processedOperationParameters);
         }
-        final RequestBody requestBody = operation.getRequestBody();
-        if(requestBody != null) {
+
+        RequestBody requestBody = operation.getRequestBody();
+        if (requestBody != null) {
+            // This part allows paser to put requestBody inline without the resolveFully
+            // option set to true
+            if (requestBody.get$ref() != null && cache != null && cache.getParseOptions() != null && cache.getParseOptions().isResolveRequestBody()) {
+                requestBodyProcessor.processRequestBody(requestBody);
+                RefFormat refFormat = computeRefFormat(requestBody.get$ref());
+                RequestBody resolvedRequestBody = cache.loadRef(requestBody.get$ref(), refFormat, RequestBody.class);
+
+                if (resolvedRequestBody != null) {
+                    requestBody = resolvedRequestBody;
+                    operation.setRequestBody(resolvedRequestBody);
+                }
+            }
             requestBodyProcessor.processRequestBody(requestBody);
         }
 
-
         final Map<String, ApiResponse> responses = operation.getResponses();
         if (responses != null) {
             for (String responseCode : responses.keySet()) {
                 ApiResponse response = responses.get(responseCode);
                 if(response != null) {
-                    //This part allows parser to put response schema inline without the resolveFully option set to true
+                    //This part allows parser to put response inline without the resolveFully option set to true
                     if (response.get$ref() != null) {
 
                         responseProcessor.processResponse(response);

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java

@@ -621,9 +621,12 @@ 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("[-/.]+");
-					Arrays.stream(eachPart)
-							.filter(part -> part.startsWith("{") && part.endsWith("}") && part.length() > 2)
+                    List<String> eachPart = new ArrayList<>();
+                    Matcher m = Pattern.compile("\\{(.+?)\\}").matcher(pathName);
+                    while (m.find()) {
+                        eachPart.add(m.group());
+                    }
+					eachPart.stream()
 							.forEach(part -> {
 								String pathParam = part.substring(1, part.length() - 1);
 								boolean definedInPathLevel = isPathParamDefined(pathParam,

modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIResolverTest.java

@@ -595,6 +595,30 @@ public void testIssue1170(@Injectable final List<AuthorizationValue> auths) {
         assertTrue(colouringPropertySchema == colouringsSchema);
 
     }
+    
+    @Test
+    public void testIssue1706() {
+        String path = "/issue-1706/SimpleRequestResponseRef.json";
+
+        ParseOptions options = new ParseOptions();
+        options.setResolve(true);
+        // Added this parseOption to make requestBody inline in the operation resolve processing flow.
+        options.setResolveRequestBody(true);
+
+        OpenAPI openAPI = new OpenAPIV3Parser().readLocation(path, null, options).getOpenAPI();
+        
+        // RequestBody should be inline
+        assertTrue(openAPI.getPaths().get("/resource").getPost().getRequestBody().get$ref() == null);
+        assertTrue(openAPI.getPaths().get("/resource").getPost().getRequestBody().getContent() != null);
+        assertTrue(openAPI.getPaths().get("/resource").getPost().getRequestBody().getContent().get("application/json").getSchema() instanceof ObjectSchema);
+        
+        // Responses are already by default made inline in case referenced.
+        assertTrue(openAPI.getPaths().get("/resource").getPost().getResponses().get("200").get$ref() == null);
+        assertTrue(openAPI.getPaths().get("/resource").getPost().getResponses().get("200").getContent() != null);
+        assertTrue(openAPI.getPaths().get("/resource").getPost().getResponses().get("200").getContent().get("application/json").getSchema() instanceof ObjectSchema);        
+    }
+    
+    
 
     @Test
     public void selfReferenceTest(@Injectable final List<AuthorizationValue> auths) {

modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIV3ParserTest.java

@@ -806,6 +806,18 @@ public void testIssue1169() {
         assertNotNull(apispec);
     }
 
+    @Test
+    public void testIssue1169noSplit() {
+        ParseOptions options = new ParseOptions();
+        options.setResolve(true);
+        SwaggerParseResult parseResult = new OpenAPIV3Parser().readLocation("issue1169-noSplit.yaml", null, options);
+        assertTrue(parseResult.getMessages().size() == 0);
+        OpenAPI apispec = parseResult.getOpenAPI();
+        assertNotNull(apispec);
+    }
+
+
+
     @Test
     public void testIssue339() throws Exception {
         OpenAPIV3Parser openAPIV3Parser = new OpenAPIV3Parser();

modules/swagger-parser-v3/src/test/resources/issue-1706/SimpleRequestResponseRef.json

@@ -0,0 +1,89 @@
+{
+    "openapi": "3.0.0",
+    "info": {
+        "version": "1.0",
+        "title": "Resource service",
+        "description": "Resource service"
+    },
+    "servers": [
+        {
+            "url": "http://localhost:8088/"
+        }
+    ],
+    "paths": {
+        "/resource": {
+            "post": {
+                "summary": "postResource",
+                "description": "postResource",
+                "operationId": "post-resource",
+                "parameters": [],
+                "requestBody": {
+                    "$ref": "#/components/requestBodies/ResourceBodyPost"
+                },
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/ResourceSuccessResponse"
+                    }
+                }
+            }
+        }
+    },
+    "components": {
+        "requestBodies": {
+            "ResourceBodyPost": {
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "required": [
+                                "rqname"
+                            ],
+                            "properties": {
+                                "rqname": {
+                                    "type": "string"
+                                },
+                                "rqnumber": {
+                                    "type": "integer",
+                                    "format": "int32"
+                                },
+                                "rqflag": {
+                                    "type": "boolean"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "responses": {
+            "ResourceSuccessResponse": {
+                "description": "a Element to be returned",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "required": [
+                                "rname"
+                            ],
+                            "properties": {
+                                "rname": {
+                                    "type": "string"
+                                },
+                                "rnumber": {
+                                    "type": "integer",
+                                    "format": "int32"
+                                },
+                                "rflag": {
+                                    "type": "boolean"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "schemas": {
+            
+        }
+    }
+}

modules/swagger-parser-v3/src/test/resources/issue1169-noSplit.yaml

@@ -0,0 +1,35 @@
+openapi: 3.0.1
+info:
+  title: Sample title
+  version: 1.0.0
+servers:
+  - url: /
+paths:
+  /path_{p0}/{p1}{p2}/another-{p3}:
+    put:
+      parameters:
+        - name: p0
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: p1
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: p2
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: p3
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: sample desc
+          content: {}
+components: {}