feat: Introducing x-example attribute for Swagger non-body parameters

package.json

@@ -21,7 +21,7 @@
     "deckardcain": "^0.3.2",
     "fury": "^2.1.0",
     "fury-adapter-apib-parser": "^0.3.0",
-    "fury-adapter-swagger": "^0.8.1",
+    "fury-adapter-swagger": "^0.9.1",
     "sift": "^3.2.1",
     "traverse": "^0.6.6",
     "uri-template": "^1.0.0"

src/compile.coffee

@@ -145,6 +145,7 @@ compileParameters = (hrefVariables) ->
       default: defaultValue
       example: exampleValue
       values: if value?.element is 'enum' then ({value: content(v)} for v in content(value)) else []
+
   parameters
 
 

test/fixtures/api-blueprint/example-parameter.apib

@@ -0,0 +1,22 @@
+FORMAT: 1A
+
+# Beehive API
+
+## Honey [/honey{?beekeeper}]
+
++ Parameters
+    + beekeeper: Honza (enum[string])
+
+        Description...
+
+        + Members
+            + Adam
+            + Honza
+            + Dredd
+        + Default: `Dredd`
+
+### Remove [DELETE]
+
++ Request (application/json)
+
++ Response 200

test/fixtures/index.coffee

@@ -115,6 +115,10 @@ fixtures =
     apiBlueprint: fromFile('./api-blueprint/default-required.apib')
     swagger: fromFile('./swagger/default-required.yml')
   )
+  exampleParameter: fixture(
+    apiBlueprint: fromFile('./api-blueprint/example-parameter.apib')
+    swagger: fromFile('./swagger/example-parameter.yml')
+  )
 
   # Specific to API Blueprint
   unrecognizable: fixture(

test/fixtures/swagger/example-parameter.yml

@@ -0,0 +1,44 @@
+swagger: "2.0"
+info:
+  version: "1.0"
+  title: Petstore
+  description: A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification
+host: petstore.swagger.io
+basePath: /
+schemes:
+  - http
+consumes:
+  - application/json
+produces:
+  - application/json
+paths:
+  /honey:
+    get:
+      parameters:
+        - name: beekeeper
+          in: query
+          type: string
+          enum:
+            - Adam
+            - Honza
+            - Dredd
+          x-example: Honza
+          default: Dredd
+      responses:
+        200:
+          description: pet response
+          schema:
+            $ref: '#/definitions/Pet'
+definitions:
+  Pet:
+    required:
+      - id
+      - name
+    properties:
+      id:
+        type: integer
+        format: int64
+      name:
+        type: string
+      tag:
+        type: string

test/integration/compile-test.coffee

@@ -349,6 +349,24 @@ describe('compile() · all API description formats', ->
     )
   )
 
+  describe('with parameter having an example value', ->
+    transaction = undefined
+
+    fixtures.exampleParameter.forEachDescribe(({source}) ->
+      beforeEach((done) ->
+        compileFixture(source, (args...) ->
+          [err, compilationResult] = args
+          transaction = compilationResult.transactions[0]
+          done(err)
+        )
+      )
+
+      it('expands the request URI with the example value', ->
+        assert.equal(transaction.request.uri, '/honey?beekeeper=Honza')
+      )
+    )
+  )
+
   describe('with response schema', ->
     transaction = undefined