Skip to content

[Javascript] Support for ByteArray and Binary #5194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 1 commit into from
Mar 26, 2017
Merged

[Javascript] Support for ByteArray and Binary #5194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions ...s/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import io.swagger.models.Swagger;
import io.swagger.models.properties.ArrayProperty;
import io.swagger.models.properties.BooleanProperty;
import io.swagger.models.properties.ByteArrayProperty;
import io.swagger.models.properties.DateProperty;
import io.swagger.models.properties.DateTimeProperty;
import io.swagger.models.properties.DoubleProperty;
Expand Down Expand Up @@ -113,7 +114,7 @@ public JavascriptClientCodegen() {
);

languageSpecificPrimitives = new HashSet<String>(
Arrays.asList("String", "Boolean", "Number", "Array", "Object", "Date", "File")
Arrays.asList("String", "Boolean", "Number", "Array", "Object", "Date", "File", "Blob")
);
defaultIncludes = new HashSet<String>(languageSpecificPrimitives);

Expand All @@ -138,8 +139,8 @@ public JavascriptClientCodegen() {
typeMapping.put("object", "Object");
typeMapping.put("integer", "Number");
// binary not supported in JavaScript client right now, using String as a workaround
typeMapping.put("ByteArray", "String"); // I don't see ByteArray defined in the Swagger docs.
typeMapping.put("binary", "String");
typeMapping.put("ByteArray", "Blob"); // I don't see ByteArray defined in the Swagger docs.
typeMapping.put("binary", "Blob");
typeMapping.put("UUID", "String");

importMapping.clear();
Expand Down Expand Up @@ -652,7 +653,7 @@ public void setParameterExampleValue(CodegenParameter p) {
* @return Normalized type
*/
public String normalizeType(String type) {
return type.replaceAll("\\b(Boolean|Integer|Number|String|Date)\\b", "'$1'");
return type.replaceAll("\\b(Boolean|Integer|Number|String|Date|Blob)\\b", "'$1'");
}

@Override
Expand Down
6 changes: 6 additions & 0 deletions modules/swagger-codegen/src/main/resources/Javascript/ApiClient.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,10 @@
request.accept(accept);
}

if (returnType === 'Blob') {
request.responseType('blob');
}

// Attach previously saved cookies, if enabled
if (this.enableCookies){
if (typeof window === 'undefined') {
Expand Down Expand Up @@ -501,6 +505,8 @@
return String(data);
case 'Date':
return this.parseDate(String(data));
case 'Blob':
return data;
default:
if (type === Object) {
// generic object, return directly
Expand Down
2 changes: 1 addition & 1 deletion modules/swagger-codegen/src/main/resources/Javascript/package.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"test": "./node_modules/mocha/bin/mocha --recursive"
},
"dependencies": {
"superagent": "1.7.1"
"superagent": "3.5.2"
},
"devDependencies": {
"mocha": "~2.3.4",
Expand Down
4 changes: 2 additions & 2 deletions modules/swagger-codegen/src/test/java/io/swagger/codegen/javascript/JavaScriptModelTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,10 +420,10 @@ public void binaryDataTest() {
Assert.assertEquals(property.baseName, "inputBinaryData");
Assert.assertEquals(property.getter, "getInputBinaryData");
Assert.assertEquals(property.setter, "setInputBinaryData");
Assert.assertEquals(property.datatype, "String");
Assert.assertEquals(property.datatype, "Blob");
Assert.assertEquals(property.name, "inputBinaryData");
Assert.assertEquals(property.defaultValue, null);
Assert.assertEquals(property.baseType, "String");
Assert.assertEquals(property.baseType, "Blob");
Assert.assertFalse(property.hasMore);
Assert.assertFalse(property.required);
Assert.assertTrue(property.isNotContainer);
Expand Down
8 changes: 4 additions & 4 deletions samples/client/petstore/javascript-promise/docs/FakeApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,15 @@ var _double = 1.2; // Number | None

var patternWithoutDelimiter = "patternWithoutDelimiter_example"; // String | None

var _byte = "B"; // String | None
var _byte = B; // Blob | None

var opts = {
'integer': 56, // Number | None
'int32': 56, // Number | None
'int64': 789, // Number | None
'_float': 3.4, // Number | None
'_string': "_string_example", // String | None
'binary': "B", // String | None
'binary': B, // Blob | None
'_date': new Date("2013-10-20"), // Date | None
'dateTime': new Date("2013-10-20T19:20:30+01:00"), // Date | None
'password': "password_example", // String | None
Expand All @@ -107,13 +107,13 @@ Name | Type | Description | Notes
**_number** | **Number**| None |
**_double** | **Number**| None |
**patternWithoutDelimiter** | **String**| None |
**_byte** | **String**| None |
**_byte** | **Blob**| None |
**integer** | **Number**| None | [optional]
**int32** | **Number**| None | [optional]
**int64** | **Number**| None | [optional]
**_float** | **Number**| None | [optional]
**_string** | **String**| None | [optional]
**binary** | **String**| None | [optional]
**binary** | **Blob**| None | [optional]
**_date** | **Date**| None | [optional]
**dateTime** | **Date**| None | [optional]
**password** | **String**| None | [optional]
Expand Down
4 changes: 2 additions & 2 deletions samples/client/petstore/javascript-promise/docs/FormatTest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Name | Type | Description | Notes
**_float** | **Number** | | [optional]
**_double** | **Number** | | [optional]
**_string** | **String** | | [optional]
**_byte** | **String** | |
**binary** | **String** | | [optional]
**_byte** | **Blob** | |
**binary** | **Blob** | | [optional]
**_date** | **Date** | |
**dateTime** | **Date** | | [optional]
**uuid** | **String** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/javascript-promise/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"test": "./node_modules/mocha/bin/mocha --recursive"
},
"dependencies": {
"superagent": "1.7.1"
"superagent": "3.5.2"
},
"devDependencies": {
"mocha": "~2.3.4",
Expand Down
6 changes: 6 additions & 0 deletions samples/client/petstore/javascript-promise/src/ApiClient.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,10 @@
if (accept) {
request.accept(accept);
}

if (returnType === 'Blob') {
request.responseType('blob');
}

// Attach previously saved cookies, if enabled
if (this.enableCookies){
Expand Down Expand Up @@ -477,6 +481,8 @@
return String(data);
case 'Date':
return this.parseDate(String(data));
case 'Blob':
return data;
default:
if (type === Object) {
// generic object, return directly
Expand Down
16 changes: 8 additions & 8 deletions samples/client/petstore/javascript-promise/src/api/FakeApi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,14 @@
* @param {Number} _number None
* @param {Number} _double None
* @param {String} patternWithoutDelimiter None
* @param {String} _byte None
* @param {Blob} _byte None
* @param {Object} opts Optional parameters
* @param {Number} opts.integer None
* @param {Number} opts.int32 None
* @param {Number} opts.int64 None
* @param {Number} opts._float None
* @param {String} opts._string None
* @param {String} opts.binary None
* @param {Blob} opts.binary None
* @param {Date} opts._date None
* @param {Date} opts.dateTime None
* @param {String} opts.password None
Expand Down Expand Up @@ -182,14 +182,14 @@
* @param {Number} _number None
* @param {Number} _double None
* @param {String} patternWithoutDelimiter None
* @param {String} _byte None
* @param {Blob} _byte None
* @param {Object} opts Optional parameters
* @param {Number} opts.integer None
* @param {Number} opts.int32 None
* @param {Number} opts.int64 None
* @param {Number} opts._float None
* @param {String} opts._string None
* @param {String} opts.binary None
* @param {Blob} opts.binary None
* @param {Date} opts._date None
* @param {Date} opts.dateTime None
* @param {String} opts.password None
Expand All @@ -214,8 +214,8 @@
* @param {module:model/String} opts.enumHeaderString Header parameter enum test (string) (default to -efg)
* @param {Array.<module:model/String>} opts.enumQueryStringArray Query parameter enum test (string array)
* @param {module:model/String} opts.enumQueryString Query parameter enum test (string) (default to -efg)
* @param {Number} opts.enumQueryInteger Query parameter enum test (double)
* @param {Number} opts.enumQueryDouble Query parameter enum test (double)
* @param {module:model/Number} opts.enumQueryInteger Query parameter enum test (double)
* @param {module:model/Number} opts.enumQueryDouble Query parameter enum test (double)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
*/
this.testEnumParametersWithHttpInfo = function(opts) {
Expand Down Expand Up @@ -262,8 +262,8 @@
* @param {module:model/String} opts.enumHeaderString Header parameter enum test (string) (default to -efg)
* @param {Array.<module:model/String>} opts.enumQueryStringArray Query parameter enum test (string array)
* @param {module:model/String} opts.enumQueryString Query parameter enum test (string) (default to -efg)
* @param {Number} opts.enumQueryInteger Query parameter enum test (double)
* @param {Number} opts.enumQueryDouble Query parameter enum test (double)
* @param {module:model/Number} opts.enumQueryInteger Query parameter enum test (double)
* @param {module:model/Number} opts.enumQueryDouble Query parameter enum test (double)
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
*/
this.testEnumParameters = function(opts) {
Expand Down
10 changes: 5 additions & 5 deletions samples/client/petstore/javascript-promise/src/model/FormatTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
* @alias module:model/FormatTest
* @class
* @param _number {Number}
* @param _byte {String}
* @param _byte {Blob}
* @param _date {Date}
* @param password {String}
*/
Expand Down Expand Up @@ -97,10 +97,10 @@
obj['string'] = ApiClient.convertToType(data['string'], 'String');
}
if (data.hasOwnProperty('byte')) {
obj['byte'] = ApiClient.convertToType(data['byte'], 'String');
obj['byte'] = ApiClient.convertToType(data['byte'], Blob);
}
if (data.hasOwnProperty('binary')) {
obj['binary'] = ApiClient.convertToType(data['binary'], 'String');
obj['binary'] = ApiClient.convertToType(data['binary'], Blob);
}
if (data.hasOwnProperty('date')) {
obj['date'] = ApiClient.convertToType(data['date'], 'Date');
Expand Down Expand Up @@ -147,11 +147,11 @@
*/
exports.prototype['string'] = undefined;
/**
* @member {String} byte
* @member {Blob} byte
*/
exports.prototype['byte'] = undefined;
/**
* @member {String} binary
* @member {Blob} binary
*/
exports.prototype['binary'] = undefined;
/**
Expand Down
8 changes: 4 additions & 4 deletions samples/client/petstore/javascript/docs/FakeApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ var _double = 1.2; // Number | None

var patternWithoutDelimiter = "patternWithoutDelimiter_example"; // String | None

var _byte = "B"; // String | None
var _byte = B; // Blob | None

var opts = {
'integer': 56, // Number | None
'int32': 56, // Number | None
'int64': 789, // Number | None
'_float': 3.4, // Number | None
'_string': "_string_example", // String | None
'binary': "B", // String | None
'binary': B, // Blob | None
'_date': new Date("2013-10-20"), // Date | None
'dateTime': new Date("2013-10-20T19:20:30+01:00"), // Date | None
'password': "password_example", // String | None
Expand All @@ -113,13 +113,13 @@ Name | Type | Description | Notes
**_number** | **Number**| None |
**_double** | **Number**| None |
**patternWithoutDelimiter** | **String**| None |
**_byte** | **String**| None |
**_byte** | **Blob**| None |
**integer** | **Number**| None | [optional]
**int32** | **Number**| None | [optional]
**int64** | **Number**| None | [optional]
**_float** | **Number**| None | [optional]
**_string** | **String**| None | [optional]
**binary** | **String**| None | [optional]
**binary** | **Blob**| None | [optional]
**_date** | **Date**| None | [optional]
**dateTime** | **Date**| None | [optional]
**password** | **String**| None | [optional]
Expand Down
4 changes: 2 additions & 2 deletions samples/client/petstore/javascript/docs/FormatTest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Name | Type | Description | Notes
**_float** | **Number** | | [optional]
**_double** | **Number** | | [optional]
**_string** | **String** | | [optional]
**_byte** | **String** | |
**binary** | **String** | | [optional]
**_byte** | **Blob** | |
**binary** | **Blob** | | [optional]
**_date** | **Date** | |
**dateTime** | **Date** | | [optional]
**uuid** | **String** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/javascript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"test": "./node_modules/mocha/bin/mocha --recursive"
},
"dependencies": {
"superagent": "1.7.1"
"superagent": "3.5.2"
},
"devDependencies": {
"mocha": "~2.3.4",
Expand Down
6 changes: 6 additions & 0 deletions samples/client/petstore/javascript/src/ApiClient.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,10 @@
if (accept) {
request.accept(accept);
}

if (returnType === 'Blob') {
request.responseType('blob');
}

// Attach previously saved cookies, if enabled
if (this.enableCookies){
Expand Down Expand Up @@ -488,6 +492,8 @@
return String(data);
case 'Date':
return this.parseDate(String(data));
case 'Blob':
return data;
default:
if (type === Object) {
// generic object, return directly
Expand Down
8 changes: 4 additions & 4 deletions samples/client/petstore/javascript/src/api/FakeApi.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,14 @@
* @param {Number} _number None
* @param {Number} _double None
* @param {String} patternWithoutDelimiter None
* @param {String} _byte None
* @param {Blob} _byte None
* @param {Object} opts Optional parameters
* @param {Number} opts.integer None
* @param {Number} opts.int32 None
* @param {Number} opts.int64 None
* @param {Number} opts._float None
* @param {String} opts._string None
* @param {String} opts.binary None
* @param {Blob} opts.binary None
* @param {Date} opts._date None
* @param {Date} opts.dateTime None
* @param {String} opts.password None
Expand Down Expand Up @@ -196,8 +196,8 @@
* @param {module:model/String} opts.enumHeaderString Header parameter enum test (string) (default to -efg)
* @param {Array.<module:model/String>} opts.enumQueryStringArray Query parameter enum test (string array)
* @param {module:model/String} opts.enumQueryString Query parameter enum test (string) (default to -efg)
* @param {Number} opts.enumQueryInteger Query parameter enum test (double)
* @param {Number} opts.enumQueryDouble Query parameter enum test (double)
* @param {module:model/Number} opts.enumQueryInteger Query parameter enum test (double)
* @param {module:model/Number} opts.enumQueryDouble Query parameter enum test (double)
* @param {module:api/FakeApi~testEnumParametersCallback} callback The callback function, accepting three arguments: error, data, response
*/
this.testEnumParameters = function(opts, callback) {
Expand Down
10 changes: 5 additions & 5 deletions samples/client/petstore/javascript/src/model/FormatTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
* @alias module:model/FormatTest
* @class
* @param _number {Number}
* @param _byte {String}
* @param _byte {Blob}
* @param _date {Date}
* @param password {String}
*/
Expand Down Expand Up @@ -97,10 +97,10 @@
obj['string'] = ApiClient.convertToType(data['string'], 'String');
}
if (data.hasOwnProperty('byte')) {
obj['byte'] = ApiClient.convertToType(data['byte'], 'String');
obj['byte'] = ApiClient.convertToType(data['byte'], Blob);
}
if (data.hasOwnProperty('binary')) {
obj['binary'] = ApiClient.convertToType(data['binary'], 'String');
obj['binary'] = ApiClient.convertToType(data['binary'], Blob);
}
if (data.hasOwnProperty('date')) {
obj['date'] = ApiClient.convertToType(data['date'], 'Date');
Expand Down Expand Up @@ -147,11 +147,11 @@
*/
exports.prototype['string'] = undefined;
/**
* @member {String} byte
* @member {Blob} byte
*/
exports.prototype['byte'] = undefined;
/**
* @member {String} binary
* @member {Blob} binary
*/
exports.prototype['binary'] = undefined;
/**
Expand Down