Merge pull request #987 from swagger-api/resolving-refs-dots

ref #901 - fixes references with dot in property name

Author: gracekarina

modules/swagger-parser/src/main/java/io/swagger/parser/processors/PropertyProcessor.java

@@ -2,6 +2,8 @@
 
 import io.swagger.models.Swagger;
 import io.swagger.models.properties.*;
+import io.swagger.models.refs.RefFormat;
+import io.swagger.models.refs.RefType;
 import io.swagger.parser.ResolverCache;
 
 import java.util.List;
@@ -37,7 +39,7 @@ private void processRefProperty(RefProperty refProperty) {
             final String newRef = externalRefProcessor.processRefToExternalDefinition(refProperty.get$ref(), refProperty.getRefFormat());
 
             if (newRef != null) {
-                refProperty.set$ref(newRef);
+                refProperty.set$ref(RefType.DEFINITION.getInternalPrefix()+newRef);
             }
         }
     }

modules/swagger-parser/src/test/java/io/swagger/parser/SwaggerParserTest.java

@@ -70,6 +70,12 @@ public void testIssueRelativeRefs2(){
         assertEquals(refProperty.get$ref(),"#/definitions/simpleIDType_v01");
     }
 
+    @Test
+    public void testIssueDefinitionWithDots_2() {
+        Swagger swagger = new SwaggerParser().read("SimpleAPI.yaml");
+        assertNotNull(swagger);
+    }
+
     @Test
     public void testIssueDefinitionWithDots() {
         Swagger swagger = new SwaggerParser().read("API-Service-2.0.0-swagger.yaml");
@@ -1383,7 +1389,7 @@ public void checkExtRefResolveInPropertiesWithAllOf() {
         assertEquals(1, property.getAllOf().size());
 
         RefProperty refProperty = (RefProperty) property.getAllOf().get(0);
-        assertEquals("#/definitions/def", refProperty.get$ref());
+        assertEquals("#/definitions/def.def", refProperty.get$ref());
 
     }
 

modules/swagger-parser/src/test/resources/SimpleAPI.yaml

@@ -0,0 +1,109 @@
+swagger: '2.0'
+info:
+  description: This is a simple API
+  version: 1.0.0
+  title: Simple Inventory API
+  # put the contact info for your development or API team
+  contact:
+    email: [email protected]
+
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+
+# tags are used for organizing operations
+tags:
+  - name: admins
+    description: Secured Admin-only calls
+  - name: developers
+    description: Operations available to regular developers
+
+paths:
+  /inventory:
+    get:
+      tags:
+        - developers
+      summary: searches inventory
+      operationId: searchInventory
+      description: |
+        By passing in the appropriate options, you can search for
+        available inventory in the system
+      produces:
+        - application/json
+      parameters:
+        - in: query
+          name: searchString
+          description: pass an optional search string for looking up inventory
+          required: false
+          type: string
+        - in: query
+          name: skip
+          description: number of records to skip for pagination
+          type: integer
+          format: int32
+          minimum: 0
+        - in: query
+          name: limit
+          description: maximum number of records to return
+          type: integer
+          format: int32
+          minimum: 0
+          maximum: 50
+      responses:
+        200:
+          description: search results matching criteria
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/Inventory.Item'
+        400:
+          description: bad input parameter
+    post:
+      tags:
+        - admins
+      summary: adds an inventory item
+      operationId: addInventory
+      description: Adds an item to the system
+      consumes:
+        - application/json
+      produces:
+        - application/json
+      parameters:
+        - in: body
+          name: inventoryItem
+          description: Inventory item to add
+          schema:
+            $ref: '#/definitions/Inventory.Item'
+      responses:
+        201:
+          description: item created
+        400:
+          description: invalid input, object invalid
+        409:
+          description: an existing item already exists
+definitions:
+  Inventory.Item:
+    type: object
+    required:
+      - id
+      - name
+      - manufacturer
+      - releaseDate
+    properties:
+      id:
+        type: string
+        format: uuid
+        example: d290f1ee-6c54-4b01-90e6-d701748f0851
+      name:
+        type: string
+        example: Widget Adapter
+      releaseDate:
+        type: string
+        format: date-time
+        example: 2016-08-29T09:12:33.001Z
+      manufacturer:
+        $ref: 'SimpleDomain.yaml#/definitions/Item.Manufacturer'
+# Added by API Auto Mocking Plugin
+
+schemes:
+  - https

modules/swagger-parser/src/test/resources/SimpleDomain.yaml

@@ -0,0 +1,30 @@
+info:
+  description: "This is a sample Domain"
+  version: '1.0.0'
+  title: Sample Domain
+
+definitions:
+  ErrorModel:
+    required:
+      - "code"
+      - "message"
+    properties:
+      code:
+        type: "integer"
+        format: "int32"
+      message:
+        type: "string"
+  Item.Manufacturer:
+    required:
+      - name
+    properties:
+      name:
+        type: string
+        example: ACME Corporation
+      homePage:
+        type: string
+        format: url
+        example:  https://www.acme-corp.com
+      phone:
+        type: string
+        example: 408-867-5309

modules/swagger-parser/src/test/resources/allOf-property-relative-file-references/child.yaml

@@ -7,7 +7,7 @@ info:
 basePath: /api/v2/devices
 
 definitions:
-  def:
+  def.def:
     type: object
     properties:
       name:

modules/swagger-parser/src/test/resources/allOf-property-relative-file-references/parent.yaml

@@ -13,4 +13,4 @@ definitions:
       property:
         x-attr: "value"
         allOf:
-        - $ref: "./child.yaml#/definitions/def"
+        - $ref: "./child.yaml#/definitions/def.def"

modules/swagger-parser/src/test/resources/nested-external-response-references/sub-folder/common-responses.yaml

@@ -22,6 +22,6 @@ responses:
 
 definitions:      
   User:
-    $ref: '../sub-folder/sub-folder2/common-address.yaml#/definitions/Address'      
+    $ref: '../sub-folder/sub-folder2/common-address.yaml#/definitions/Address'
 #Still a BUG: Should take into account that the like is relative to this file!     
 #   $ref: 'sub-folder2/common-address.yaml#/definitions/Address'