Issue #1170 - Modified ExternalRefProcessor and ResolverFully to load and resolve $ref within array items inline object.

Author: Scott Russell

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

@@ -173,9 +173,13 @@ public String processRefToExternalSchema(String $ref, RefFormat refFormat) {
                 }
 
             }
-            if (schema instanceof ArraySchema && ((ArraySchema) schema).getItems() != null && ((ArraySchema) schema).getItems().get$ref() != null
-                    && StringUtils.isNotBlank(((ArraySchema) schema).getItems().get$ref())) {
-                processRefSchema(((ArraySchema) schema).getItems(), file);
+            if (schema instanceof ArraySchema && ((ArraySchema) schema).getItems() != null) {
+                ArraySchema arraySchema = (ArraySchema) schema;
+                if (StringUtils.isNotBlank(arraySchema.getItems().get$ref())) {
+                    processRefSchema(((ArraySchema) schema).getItems(), file);
+                } else {
+                    processProperties(arraySchema.getItems().getProperties() ,file);
+                }
             }
         }
 

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

@@ -302,12 +302,7 @@ public Schema resolveSchema(Schema schema) {
 
         if(schema instanceof ArraySchema) {
             ArraySchema arrayModel = (ArraySchema) schema;
-            if(arrayModel.getItems().get$ref() != null) {
-                arrayModel.setItems(resolveSchema(arrayModel.getItems()));
-            } else {
-                arrayModel.setItems(arrayModel.getItems());
-            }
-
+            arrayModel.setItems(resolveSchema(arrayModel.getItems()));
             return arrayModel;
         }
 

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

@@ -539,6 +539,51 @@ public void testIssue1161(@Injectable final List<AuthorizationValue> auths) {
         assertTrue(petsColouringProperty == colouringsSchema);
     }
 
+    @Test
+    public void testIssue1170(@Injectable final List<AuthorizationValue> auths) {
+        String path = "/issue-1170/swagger.yaml";
+
+        ParseOptions options = new ParseOptions();
+        options.setResolve(true);
+        options.setResolveFully(true);
+
+        OpenAPI openAPI = new OpenAPIV3Parser().readLocation(path, auths, options).getOpenAPI();
+
+        // Array schema with items $ref
+        Schema breedsListSchema = openAPI.getComponents().getSchemas().get("BreedsList");
+        Schema breedSchema = openAPI.getComponents().getSchemas().get("Breed");
+
+        assertNotNull(breedsListSchema);
+        assertNotNull(breedSchema);
+
+        assertTrue(breedsListSchema instanceof ArraySchema);
+        Schema breedPropertySchema = ((ArraySchema) breedsListSchema).getItems().getProperties().get("breed");
+        assertNotNull(breedPropertySchema);
+
+        // Verify items resolved fully
+        assertTrue(breedPropertySchema.get$ref() == null);
+        assertTrue(breedPropertySchema == breedSchema);
+
+
+        // Array schema with inline items object with $ref properties
+        Schema petsListSchema = openAPI.getComponents().getSchemas().get("PetsList");
+        Schema colouringsSchema = openAPI.getComponents().getSchemas().get("Colouring");
+        Schema colourSchema = openAPI.getComponents().getSchemas().get("Colour");
+
+        assertNotNull(petsListSchema);
+        assertNotNull(colouringsSchema);
+        assertNotNull(colourSchema);
+
+        assertTrue(petsListSchema instanceof ArraySchema);
+        Schema colouringPropertySchema = ((ArraySchema) petsListSchema).getItems().getProperties().get("colouring");
+        assertNotNull(colouringPropertySchema);
+
+        // Verify inline items resolved fully
+        assertTrue(colouringPropertySchema.get$ref() == null);
+        assertTrue(colouringPropertySchema == colouringsSchema);
+
+    }
+
     @Test
     public void selfReferenceTest(@Injectable final List<AuthorizationValue> auths) {
         String yaml = "" +

modules/swagger-parser-v3/src/test/resources/issue-1170/common.yaml

@@ -0,0 +1,47 @@
+openapi: "3.0.2"
+info:
+  version: 15.3.0
+  title: "Common Data Types"
+paths: {}
+components:
+  schemas:
+    BreedsList:
+      type: array
+      items:
+        $ref: '#/components/schemas/BreedsListItems'
+
+    BreedsListItems:
+      type: object
+      properties:
+        breed:
+          $ref: '#/components/schemas/Breed'
+
+    Breed:
+      type: object
+      properties:
+        name:
+          type: string
+        family:
+          type: string
+
+    PetsList:
+      type: array
+      items:
+        type: object
+        properties:
+          petType:
+            type: string
+          colouring:
+            $ref: '#/components/schemas/Colouring'
+
+    Colouring:
+      type: object
+      properties:
+        primary:
+          $ref: '#/components/schemas/Colour'
+        secondary:
+          $ref: '#/components/schemas/Colour'
+
+    Colour:
+      type: string
+      enum: ['black', 'white', 'tan', 'red', 'blue']

modules/swagger-parser-v3/src/test/resources/issue-1170/swagger.yaml

@@ -0,0 +1,35 @@
+openapi: "3.0.2"
+info:
+  version: 15.3.0
+  title: test
+paths:
+  /add-breeds:
+    put:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: 'common.yaml#/components/schemas/BreedsList'
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            text/plain:
+              schema:
+                type: string
+
+  /add-pets:
+    put:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: 'common.yaml#/components/schemas/PetsList'
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            text/plain:
+              schema:
+                type: string
+