Merge pull request #935 from swagger-api/issue-825

Support allowEmptyValues

Author: fehguy

browser/swagger-client.js

@@ -539,6 +539,26 @@ Operation.prototype.urlify = function (args, maskPasswords) {
       } else if (param.in === 'formData') {
         formParams[param.name] = args[param.name];
       }
+    } else if(param.in === 'query' && typeof args[param.name] === 'undefined' && param.allowEmptyValue === true) {
+      if (querystring === '' && requestUrl.indexOf('?') < 0) {
+        querystring += '?';
+      } else {
+        querystring += '&';
+      }
+
+      if (typeof param.collectionFormat !== 'undefined' || param.type === 'array') {
+        var qp;
+        var collectionFormat = param.collectionFormat || 'multi';
+
+        if (Array.isArray(qp)) {
+          querystring += this.encodeQueryCollection(collectionFormat, param.name, qp, isPassword);
+        } else {
+          querystring += this.encodeQueryCollection(collectionFormat, param.name, [qp], isPassword);
+        }
+      } else {
+        querystring += this.encodeQueryKey(param.name) + '=' + this.encodeQueryParam('', isPassword);
+      }
+
     }
   }
   var url = this.scheme + '://' + this.host;
@@ -1222,7 +1242,12 @@ Operation.prototype.encodeQueryParam = function (arg, maskPasswords) {
   if(maskPasswords) {
     return "******";
   }
-  return encodeURIComponent(arg);
+  if(arg) {
+    return encodeURIComponent(arg);
+  }
+  else {
+    return '';
+  }
 };
 
 /**

browser/swagger-client.min.js

@@ -8,7 +8,7 @@
     }
   ],
   "description": "swagger-client is a javascript client for use with swaggering APIs.",
-  "version": "2.1.30",
+  "version": "2.1.31",
   "homepage": "http://swagger.io",
   "repository": {
     "type": "git",

lib/types/operation.js

@@ -1583,4 +1583,77 @@ describe('SwaggerClient', function () {
       done(exception);
     });
   });
+
+  it('honors allowEmptyValue #825', function(done) {
+    var spec = {
+      basePath: '/double/',
+      paths: {
+        '/foo': {
+          get: {
+            tags: [
+              'test'
+            ],
+            operationId: 'slash',
+            parameters: [{
+              in: 'query',
+              allowEmptyValue: true,
+              name: 'happy',
+              type: 'string',
+              required: false
+            }],
+          }
+        }
+      }
+    };
+    new SwaggerClient({
+      url: 'http://localhost:8000/v2/swagger.json',
+      spec: spec,
+      usePromise: true
+    }).then(function(client) {
+      var mock = client.test.slash({}, {mock: true});
+      expect(mock.url).toBe('http://localhost:8000/double/foo?happy=');
+
+      done();
+    }).catch(function(exception) {
+      done(exception);
+    });
+  });
+
+  it('honors allowEmptyValue #825 in arrays', function(done) {
+    var spec = {
+      basePath: '/double/',
+      paths: {
+        '/foo': {
+          get: {
+            tags: [
+              'test'
+            ],
+            operationId: 'slash',
+            parameters: [{
+              in: 'query',
+              allowEmptyValue: true,
+              name: 'happy',
+              type: 'array',
+              items: {
+                type: 'string'
+              },
+              required: false
+            }],
+          }
+        }
+      }
+    };
+    new SwaggerClient({
+      url: 'http://localhost:8000/v2/swagger.json',
+      spec: spec,
+      usePromise: true
+    }).then(function(client) {
+      var mock = client.test.slash({}, {mock: true});
+      expect(mock.url).toBe('http://localhost:8000/double/foo?happy=');
+
+      done();
+    }).catch(function(exception) {
+      done(exception);
+    });
+  });
 });