Empty strings as valid values for URI parameters

src/expand-uri-template-with-parameters.coffee

@@ -41,9 +41,9 @@ expandUriTemplateWithParameters = (uriTemplate, parameters) ->
       for uriParameter in uriParameters
         param = parameters[uriParameter]
 
-        if param.example
+        if param.example?
           toExpand[uriParameter] = param.example
-        else if param.default
+        else if param.default?
           toExpand[uriParameter] = param.default
         else
           if param.required
@@ -54,7 +54,7 @@ expandUriTemplateWithParameters = (uriTemplate, parameters) ->
               document: #{uriParameter}\
             """)
 
-        if param.required and param.default
+        if param.required and param.default?
           result.warnings.push("""\
             Required URI parameter '#{uriParameter}' has a default value.
             Default value for a required parameter doesn't make sense from \

src/validate-parameters.coffee

@@ -3,18 +3,24 @@ validateParameters = (params) ->
   result = {warnings: [], errors: []}
 
   for paramName, param of params
-    if param.required and not param.example and not param.default
+    if param.required and not (param.example? or param.default?)
       text = "Required URI parameter '#{paramName}' has no example or default value."
       result.errors.push(text)
 
     switch param.type
       when 'number'
-        if isNaN(parseFloat(param.example))
-          text = "URI parameter '#{paramName}' is declared as 'number' but it is a string."
+        if param.example? and isNaN(parseFloat(param.example))
+          text = "URI parameter '#{paramName}' is declared as 'number' but its example value '#{param.example}' is not."
+          result.errors.push(text)
+        if param.default? and isNaN(parseFloat(param.default))
+          text = "URI parameter '#{paramName}' is declared as 'number' but its default value '#{param.example}' is not."
           result.errors.push(text)
       when 'boolean'
-        if param.example isnt 'true' and param.example isnt 'false'
-          text = "URI parameter '#{paramName}' is declared as 'boolean' but it is not."
+        if param.example? and param.example isnt 'true' and param.example isnt 'false'
+          text = "URI parameter '#{paramName}' is declared as 'boolean' but its example value '#{param.example}' is not."
+          result.errors.push(text)
+        if param.default? and param.default isnt 'true' and param.default isnt 'false'
+          text = "URI parameter '#{paramName}' is declared as 'boolean' but its default value '#{param.example}' is not."
           result.errors.push(text)
 
     if param.values.length > 0

test/fixtures/api-blueprint/default-required-boolean.apib

@@ -0,0 +1,12 @@
+FORMAT: 1A
+
+# Beehive API
+
+## Honey [/honey{?exampleBool}]
+
+### Get [GET]
+
++ Parameters
+    + exampleBool: `false` (required, boolean)
+
++ Response 200

test/fixtures/index.coffee

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

test/fixtures/swagger/default-required-boolean.yml

@@ -0,0 +1,40 @@
+swagger: "2.0"
+info:
+  version: "1.0"
+  title: Beehive API
+  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: exampleBool
+          in: query
+          type: boolean
+          required: true
+          default: 'false'
+      responses:
+        200:
+          description: Sample description
+          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

@@ -505,4 +505,23 @@ describe('compile() · all API description formats', ->
       )
     )
   )
+
+  describe('with example boolean value of URI parameter', ->
+    transaction = undefined
+    errors = undefined
+
+    fixtures.defaultRequiredBoolean.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?exampleBool=false')
+      )
+    )
+  )
+
 )