Skip to content

Support RFC 6570 optional path segments #935

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

Closed
wants to merge 2 commits into from
Closed

Support RFC 6570 optional path segments #935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d639f9d
Support RFC 6570 optional path segments
gwicke Feb 13, 2015
4a08d53
Merge pull request #1 from gwicke/master
gwicke Feb 13, 2015
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
48 changes: 28 additions & 20 deletions dist/lib/swagger-client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ var ArrayModel = function(definition) {
this.name = "arrayModel";
this.definition = definition || {};
this.properties = [];

var requiredFields = definition.enum || [];
var innerType = definition.items;
if(innerType) {
Expand Down Expand Up @@ -836,7 +836,13 @@ Operation.prototype.urlify = function (args) {
value = this.encodePathCollection(param.collectionFormat, param.name, value);
else
value = this.encodePathParam(value);
requestUrl = requestUrl.replace(reg, value);
if(reg.exec(requestUrl)) {
requestUrl = requestUrl.replace(reg, value);
} else {
// Try optional path segments {/param} too
var optionalReg = new RegExp('\{\\/' + param.name + '\}', 'gi');
requestUrl = requestUrl.replace(optionalReg, '/' + value);
}
}
else if (param.in === 'query' && typeof args[param.name] !== 'undefined') {
if(querystring === '')
Expand All @@ -857,6 +863,8 @@ Operation.prototype.urlify = function (args) {
formParams[param.name] = args[param.name];
}
}
// Strip out remaining optional path segments
requestUrl = requestUrl.replace(/\{\/[^\/}]+\}/g, '');
var url = this.scheme + '://' + this.host;

if(this.basePath !== '/')
Expand Down Expand Up @@ -1416,7 +1424,7 @@ Property.prototype.toString = function() {
}


var options = '';
var options = '';
var isArray = this.schema.type === 'array';
var type;

Expand Down Expand Up @@ -1478,11 +1486,11 @@ Property.prototype.toString = function() {
}

options += optionHtml('Enum', enumString);
}
}

if (options.length > 0)
str = '<span class="propWrap">' + str + '<table class="optionsWrapper"><tr><th colspan="2">' + this.name + '</th></tr>' + options + '</table></span>';

return str;
};

Expand Down Expand Up @@ -1842,11 +1850,11 @@ SwaggerResource.prototype.addOperations = function (resource_path, ops, consumes
o.summary,
o.notes,
type,
responseMessages,
this,
consumes,
produces,
o.authorizations,
responseMessages,
this,
consumes,
produces,
o.authorizations,
o.deprecated);

this.operations[op.nickname] = op;
Expand Down Expand Up @@ -2328,15 +2336,15 @@ SwaggerOperation.prototype.urlify = function (args) {
param = params[i];
if(param.paramType === 'query') {
if (queryParams !== '')
queryParams += '&';
queryParams += '&';
if (Array.isArray(param)) {
var output = '';
for(j = 0; j < param.length; j++) {
if(j > 0)
output += ',';
output += encodeURIComponent(param[j]);
}
queryParams += encodeURIComponent(param.name) + '=' + output;
var output = '';
for(j = 0; j < param.length; j++) {
if(j > 0)
output += ',';
output += encodeURIComponent(param[j]);
}
queryParams += encodeURIComponent(param.name) + '=' + output;
}
else {
if (typeof args[param.name] !== 'undefined') {
Expand Down Expand Up @@ -2402,7 +2410,7 @@ SwaggerOperation.prototype.asCurl = function (args) {
var results = [];
var i;

var headers = SwaggerRequest.prototype.setHeaders(args, {}, this);
var headers = SwaggerRequest.prototype.setHeaders(args, {}, this);
for(i = 0; i < this.parameters.length; i++) {
var param = this.parameters[i];
if(param.paramType && param.paramType === 'header' && args[param.name]) {
Expand Down Expand Up @@ -2929,4 +2937,4 @@ e.SwaggerClient = SwaggerClient;
e.Operation = Operation;
e.Model = Model;
e.models = models;
})();
})();
48 changes: 28 additions & 20 deletions lib/swagger-client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ var ArrayModel = function(definition) {
this.name = "arrayModel";
this.definition = definition || {};
this.properties = [];

var requiredFields = definition.enum || [];
var innerType = definition.items;
if(innerType) {
Expand Down Expand Up @@ -836,7 +836,13 @@ Operation.prototype.urlify = function (args) {
value = this.encodePathCollection(param.collectionFormat, param.name, value);
else
value = this.encodePathParam(value);
requestUrl = requestUrl.replace(reg, value);
if(reg.exec(requestUrl)) {
requestUrl = requestUrl.replace(reg, value);
} else {
// Try optional path segments {/param} too
var optionalReg = new RegExp('\{\\/' + param.name + '\}', 'gi');
requestUrl = requestUrl.replace(optionalReg, '/' + value);
}
}
else if (param.in === 'query' && typeof args[param.name] !== 'undefined') {
if(querystring === '')
Expand All @@ -857,6 +863,8 @@ Operation.prototype.urlify = function (args) {
formParams[param.name] = args[param.name];
}
}
// Strip out remaining optional path segments
requestUrl = requestUrl.replace(/\{\/[^\/}]+\}/g, '');
var url = this.scheme + '://' + this.host;

if(this.basePath !== '/')
Expand Down Expand Up @@ -1416,7 +1424,7 @@ Property.prototype.toString = function() {
}


var options = '';
var options = '';
var isArray = this.schema.type === 'array';
var type;

Expand Down Expand Up @@ -1478,11 +1486,11 @@ Property.prototype.toString = function() {
}

options += optionHtml('Enum', enumString);
}
}

if (options.length > 0)
str = '<span class="propWrap">' + str + '<table class="optionsWrapper"><tr><th colspan="2">' + this.name + '</th></tr>' + options + '</table></span>';

return str;
};

Expand Down Expand Up @@ -1842,11 +1850,11 @@ SwaggerResource.prototype.addOperations = function (resource_path, ops, consumes
o.summary,
o.notes,
type,
responseMessages,
this,
consumes,
produces,
o.authorizations,
responseMessages,
this,
consumes,
produces,
o.authorizations,
o.deprecated);

this.operations[op.nickname] = op;
Expand Down Expand Up @@ -2328,15 +2336,15 @@ SwaggerOperation.prototype.urlify = function (args) {
param = params[i];
if(param.paramType === 'query') {
if (queryParams !== '')
queryParams += '&';
queryParams += '&';
if (Array.isArray(param)) {
var output = '';
for(j = 0; j < param.length; j++) {
if(j > 0)
output += ',';
output += encodeURIComponent(param[j]);
}
queryParams += encodeURIComponent(param.name) + '=' + output;
var output = '';
for(j = 0; j < param.length; j++) {
if(j > 0)
output += ',';
output += encodeURIComponent(param[j]);
}
queryParams += encodeURIComponent(param.name) + '=' + output;
}
else {
if (typeof args[param.name] !== 'undefined') {
Expand Down Expand Up @@ -2402,7 +2410,7 @@ SwaggerOperation.prototype.asCurl = function (args) {
var results = [];
var i;

var headers = SwaggerRequest.prototype.setHeaders(args, {}, this);
var headers = SwaggerRequest.prototype.setHeaders(args, {}, this);
for(i = 0; i < this.parameters.length; i++) {
var param = this.parameters[i];
if(param.paramType && param.paramType === 'header' && args[param.name]) {
Expand Down Expand Up @@ -2929,4 +2937,4 @@ e.SwaggerClient = SwaggerClient;
e.Operation = Operation;
e.Model = Model;
e.models = models;
})();
})();