Merge pull request #1482 from volkodava/fix-nested-defs-in-subfolder

fixed bug related to nested definitions within subfolder

Author: gracekarina

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

@@ -1,7 +1,9 @@
 package io.swagger.v3.parser.processors;
 
 
+import java.io.File;
 import java.net.URI;
+import java.nio.file.Paths;
 import java.util.Collection;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -111,7 +113,12 @@ public String processRefToExternalSchema(String $ref, RefFormat refFormat) {
             if (schema.get$ref() != null) {
                 RefFormat ref = computeRefFormat(schema.get$ref());
                 if (isAnExternalRefFormat(ref)) {
-                    schema.set$ref(processRefToExternalSchema(schema.get$ref(), ref));
+                    String schemaFullRef = schema.get$ref();
+                    String parent = file.substring(0, file.lastIndexOf(File.separatorChar));
+                    if (!parent.isEmpty()) {
+                        schemaFullRef = Paths.get(parent, schemaFullRef).normalize().toString();
+                    }
+                    schema.set$ref(processRefToExternalSchema(schemaFullRef, ref));
                 } else {
                     processRefToExternalSchema(file + schema.get$ref(), RefFormat.RELATIVE);
                 }

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

@@ -1296,6 +1296,69 @@ public void testLoadExternalNestedDefinitions() throws Exception {
         assertEquals( definitions.get("k").getTitle(), "k-definition");
     }
 
+    @Test
+    public void testLoadExternalNestedDefinitionsWithReferenceWithinSubfolder() throws Exception {
+        OpenAPIV3Parser parser = new OpenAPIV3Parser();
+        final OpenAPI openAPI = parser.read("src/test/resources/nested-references-2/main.yaml");
+
+        Map<String, Schema> definitions = openAPI.getComponents().getSchemas();
+        assertTrue(definitions.containsKey("GreetingResponse"));
+        assertTrue(definitions.containsKey("GreetingMessage"));
+        assertTrue(definitions.containsKey("greeting-message"));
+
+        String greetingMessageRef = ((Schema) definitions.get("GreetingResponse")
+                .getProperties().get("GreetingMessage")).get$ref();
+
+        assertEquals(greetingMessageRef,"#/components/schemas/GreetingMessage");
+        assertEquals(definitions.get("GreetingMessage").get$ref(),"#/components/schemas/greeting-message");
+
+        String description = ((Schema)definitions.get("greeting-message")
+                .getProperties().get("Text")).getDescription();
+        assertEquals(description,"Text message");
+    }
+
+    @Test
+    public void testLoadExternalNestedDefinitionsWithReferenceWithinSameFolder() throws Exception {
+        OpenAPIV3Parser parser = new OpenAPIV3Parser();
+        final OpenAPI openAPI = parser.read("src/test/resources/nested-references-3/main.yaml");
+
+        Map<String, Schema> definitions = openAPI.getComponents().getSchemas();
+        assertTrue(definitions.containsKey("GreetingResponse"));
+        assertTrue(definitions.containsKey("GreetingMessage"));
+        assertTrue(definitions.containsKey("greeting-message"));
+
+        String greetingMessageRef = ((Schema) definitions.get("GreetingResponse")
+                .getProperties().get("GreetingMessage")).get$ref();
+
+        assertEquals(greetingMessageRef,"#/components/schemas/GreetingMessage");
+        assertEquals(definitions.get("GreetingMessage").get$ref(),"#/components/schemas/greeting-message");
+
+        String description = ((Schema)definitions.get("greeting-message")
+                .getProperties().get("Text")).getDescription();
+        assertEquals(description,"Text message");
+    }
+
+    @Test
+    public void testLoadExternalNestedDefinitionsWithReferenceOnDifferentFolderLevels() throws Exception {
+        OpenAPIV3Parser parser = new OpenAPIV3Parser();
+        final OpenAPI openAPI = parser.read("src/test/resources/nested-references-4/main.yaml");
+
+        Map<String, Schema> definitions = openAPI.getComponents().getSchemas();
+        assertTrue(definitions.containsKey("GreetingResponse"));
+        assertTrue(definitions.containsKey("GreetingMessage"));
+        assertTrue(definitions.containsKey("greeting-message"));
+
+        String greetingMessageRef = ((Schema) definitions.get("GreetingResponse")
+                .getProperties().get("GreetingMessage")).get$ref();
+
+        assertEquals(greetingMessageRef,"#/components/schemas/GreetingMessage");
+        assertEquals(definitions.get("GreetingMessage").get$ref(),"#/components/schemas/greeting-message");
+
+        String description = ((Schema)definitions.get("greeting-message")
+                .getProperties().get("Text")).getDescription();
+        assertEquals(description,"Text message");
+    }
+
     @Test
     public void testPetstore() throws Exception {
         OpenAPIV3Parser parser = new OpenAPIV3Parser();

modules/swagger-parser-v3/src/test/resources/nested-references-2/main.yaml

@@ -0,0 +1,10 @@
+---
+openapi: "3.0.0"
+info:
+  title: test
+  version: '0.0.0'
+paths: {}
+components:
+  schemas:
+    GreetingResponse:
+      $ref: "./schemas/greeting-response.yaml"

modules/swagger-parser-v3/src/test/resources/nested-references-2/schemas/greeting-message.yaml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  Text:
+    description: Text message
+    type: string

modules/swagger-parser-v3/src/test/resources/nested-references-2/schemas/greeting-response.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  GreetingMessage:
+    $ref: ./shared-defs.yaml#/components/schemas/GreetingMessage

modules/swagger-parser-v3/src/test/resources/nested-references-2/schemas/shared-defs.yaml

@@ -0,0 +1,10 @@
+---
+openapi: "3.0.0"
+info:
+  title: shared test
+  version: '0.0.0'
+paths: { }
+components:
+  schemas:
+    GreetingMessage:
+      $ref: ./greeting-message.yaml

modules/swagger-parser-v3/src/test/resources/nested-references-3/greeting-message.yaml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  Text:
+    description: Text message
+    type: string

modules/swagger-parser-v3/src/test/resources/nested-references-3/greeting-response.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  GreetingMessage:
+    $ref: ./shared-defs.yaml#/components/schemas/GreetingMessage

modules/swagger-parser-v3/src/test/resources/nested-references-3/main.yaml

@@ -0,0 +1,10 @@
+---
+openapi: "3.0.0"
+info:
+  title: test
+  version: '0.0.0'
+paths: {}
+components:
+  schemas:
+    GreetingResponse:
+      $ref: "./greeting-response.yaml"

modules/swagger-parser-v3/src/test/resources/nested-references-3/shared-defs.yaml

@@ -0,0 +1,10 @@
+---
+openapi: "3.0.0"
+info:
+  title: shared test
+  version: '0.0.0'
+paths: { }
+components:
+  schemas:
+    GreetingMessage:
+      $ref: ./greeting-message.yaml