Support example and x-example in Swagger Properties

Author: Phil Sturgeon

src/parsers/swagger/v2.0/Parser.js

@@ -1235,6 +1235,12 @@ methods.convertParameterObjectIntoParameter = (parameterEntry) => {
     applicableContexts
   }
 
+  if (parameter.example) {
+    paramInstance.examples = List([parameter.example])
+  } else if (parameter['x-example']) {
+    paramInstance.examples = List([parameter['x-example']])
+  }
+
   if (parameter.type === 'array' && parameter.items) {
     const { value } = methods.convertParameterObjectIntoParameter({
       key: null,

src/parsers/swagger/v2.0/__tests__/Parser.spec.js

@@ -2239,7 +2239,8 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
           maximum: 321,
           minimum: 123,
           multipleOf: 5,
-          default: 100
+          default: 100,
+          example: 12345
         }
       }
 
@@ -2254,6 +2255,7 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
           required: true,
           type: 'integer',
           default: 100,
+          examples: List([12345]),
           constraints: List([
             new Constraint.Maximum(321),
             new Constraint.Minimum(123),
@@ -2283,7 +2285,8 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
             maximum: 321,
             minimum: 123,
             multipleOf: 5,
-            default: 100
+            default: 100,
+            example: 12345
           }
         }
       }
@@ -2305,6 +2308,7 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
             required: true,
             type: 'integer',
             default: 100,
+            examples: List([12345]),
             constraints: List([
               new Constraint.Maximum(321),
               new Constraint.Minimum(123),
@@ -2318,6 +2322,37 @@ describe('parsers/swagger/v2.0/Parser.js', () => {
 
       expect(actual).toEqual(expected)
     })
+
+    it('should respect x-example too', () => {
+      const entry = {
+        key: 'UserId',
+        value: {
+          name: 'userId',
+          in: 'query',
+          type: 'integer',
+          required: true,
+          'x-example': 23456
+        }
+      }
+
+      const expected = {
+        key: 'UserId',
+        value: new Parameter({
+          key: 'userId',
+          name: 'userId',
+          in: 'queries',
+          uuid: 'UserId',
+          required: true,
+          type: 'integer',
+          examples: List([23456]),
+          constraints: List()
+        })
+      }
+
+      const actual = __internals__.convertParameterObjectIntoParameter(entry)
+
+      expect(actual).toEqual(expected)
+    })
   })
 
   describe('@convertParameterObjectArrayIntoParameterMap', () => {

testing/e2e/swagger2-internal/input.json

@@ -236,7 +236,8 @@
             "description": "ID of pet that needs to be fetched",
             "required": true,
             "type": "integer",
-            "format": "int64"
+            "format": "int64",
+            "x-example": 12356789
           }
         ],
         "responses": {
@@ -414,7 +415,7 @@
           {
             "in": "path",
             "name": "orderId",
-            "description": "ID of pet that needs to be fetched",
+            "description": "ID of purchase order that needs to be fetched",
             "required": true,
             "type": "string"
           }

testing/e2e/swagger2-internal/output.json

@@ -1345,7 +1345,7 @@
                 "key": "petId",
                 "name": "petId",
                 "description": "ID of pet that needs to be fetched",
-                "examples": [],
+                "examples": [123456789],
                 "type": "integer",
                 "format": null,
                 "default": null,
@@ -2630,7 +2630,7 @@
                 "uuid": "orderId-path",
                 "key": "orderId",
                 "name": "orderId",
-                "description": "ID of pet that needs to be fetched",
+                "description": "ID of purchase order that needs to be fetched",
                 "examples": [],
                 "type": "string",
                 "format": null,
@@ -2722,7 +2722,7 @@
                 "uuid": "orderId-path",
                 "key": "orderId",
                 "name": "orderId",
-                "description": "ID of pet that needs to be fetched",
+                "description": "ID of purchase order that needs to be fetched",
                 "examples": [],
                 "type": "string",
                 "format": null,
@@ -5708,4 +5708,4 @@
     },
     "version": "1.0.0"
   }
-}
+}