Merge pull request #228 from duncanhall/fix/url-encoded-headers

Avoid URL encoding header values

Author: fehguy

lib/swagger-client.js

@@ -1,6 +1,6 @@
 /**
  * swagger-client - swagger.js is a javascript client for use with swaggering APIs.
- * @version v2.1.0-alpha.7
+ * @version v2.1.0-M1
  * @link http://swagger.io
  * @license apache 2.0
  */
@@ -795,9 +795,7 @@ Operation.prototype.getHeaderParams = function (args) {
       if (param.in === 'header') {
         var value = args[param.name];
         if(Array.isArray(value))
-          value = this.encodePathCollection(param.collectionFormat, param.name, value);
-        else
-          value = this.encodePathParam(value);
+          value = value.toString();
         headers[param.name] = value;
       }
     }

lib/swagger-client.min.js

@@ -520,9 +520,7 @@ Operation.prototype.getHeaderParams = function (args) {
       if (param.in === 'header') {
         var value = args[param.name];
         if(Array.isArray(value))
-          value = this.encodePathCollection(param.collectionFormat, param.name, value);
-        else
-          value = this.encodePathParam(value);
+          value = value.toString();
         headers[param.name] = value;
       }
     }

src/js/swagger-a.js

@@ -23,6 +23,50 @@ describe('header extraction', function() {
     expect(headers.myHeader).toBe('tony');
   });
 
+
+  it('should not URL encode header string values', function() {
+    var parameters = [
+      {
+        in: 'header',
+        name: 'myHeader',
+        type: 'string'
+      }
+    ];
+    var op = new swagger.Operation({}, 'http', 'test', 'get', '/path', { parameters: parameters });
+    var args = {
+      myHeader: 'someKey=someValue'
+    };
+
+    var url = op.urlify(args);
+    var headers = op.getHeaderParams(args);
+
+    expect(url).toBe('http://localhost/path');
+    expect(headers.myHeader).toBe('someKey=someValue');
+  });
+
+  it('should not URL encode header string array values', function() {
+    var parameters = [
+      {
+        in: 'header',
+        name: 'myHeader',
+        type: 'array',
+        items: {
+          type: 'string'
+        }
+      }
+    ];
+    var op = new swagger.Operation({}, 'http', 'test', 'get', '/path', { parameters: parameters });
+    var args = {
+      myHeader: ['firstParam=firstValue', 'secondParam=secondValue']
+    };
+
+    var url = op.urlify(args);
+    var headers = op.getHeaderParams(args);
+
+    expect(url).toBe('http://localhost/path');
+    expect(headers.myHeader).toBe('firstParam=firstValue,secondParam=secondValue');
+  });
+
   it('should extract header params with string array with default collectionFormat', function() {
     var parameters = [
       {