kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#1892 fixed multiple definition loops

Browse Source
This commit is contained in:
Anna Bodnia
2016-01-22 20:24:45 +02:00
parent 9a5925f921
commit db328351b9
4 changed files with 121 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
dist/swagger-ui.js vendored
View File

@@ -27127,7 +27127,7 @@ SwaggerUi.partials.signature = (function () {
} }
function getInfiniteLoopMessage (name) { function getInfiniteLoopMessage (name) {
return '<!-- Infinite loop to model ' + name + ' -->'; return '<!-- Infinite loop $ref:' + name + ' -->';
} }
function getErrorMessage () { function getErrorMessage () {
@@ -27135,7 +27135,10 @@ SwaggerUi.partials.signature = (function () {
} }
function createSchemaXML (name, definition, models, config) { function createSchemaXML (name, definition, models, config) {
var $ref = definition.$ref; var $ref = _.isObject(definition) ? definition.$ref : null;
var output, index;
config = config || {};
config.modelsToIgnore = config.modelsToIgnore || [];
var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models, config) var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models, config)
: getDescriptor(name, definition, models, config); : getDescriptor(name, definition, models, config);
@@ -27145,14 +27148,23 @@ SwaggerUi.partials.signature = (function () {
switch (descriptor.type) { switch (descriptor.type) {
case 'array': case 'array':
return createArrayXML(descriptor); output = createArrayXML(descriptor); break;
case 'object': case 'object':
return createObjectXML(descriptor); output = createObjectXML(descriptor); break;
case 'loop': case 'loop':
return getInfiniteLoopMessage(descriptor.name); output = getInfiniteLoopMessage(descriptor.name); break;
default: default:
return createPrimitiveXML(descriptor); output = createPrimitiveXML(descriptor);
} }
if ($ref) {
index = config.modelsToIgnore.indexOf($ref);
if (index > -1) {
config.modelsToIgnore.splice(index, 1);
}
}
return output;
} }
function Descriptor (name, type, definition, models, config) { function Descriptor (name, type, definition, models, config) {
@@ -27174,12 +27186,10 @@ SwaggerUi.partials.signature = (function () {
var name = model.name || modelType; var name = model.name || modelType;
var type = model.type || 'object'; var type = model.type || 'object';
config = config || {}; if (config.modelsToIgnore.indexOf($ref) > -1) {
config.modelsToIgnore = config.modelsToIgnore || [];
if (config.modelsToIgnore.indexOf(name) > -1) {
type = 'loop'; type = 'loop';
} else { } else {
config.modelsToIgnore.push(modelType); config.modelsToIgnore.push($ref);
} }
if (!model.definition) { if (!model.definition) {

20
dist/swagger-ui.min.js vendored
View File

File diff suppressed because one or more lines are too long

30
src/main/javascript/view/partials/signature.js
View File

@@ -824,7 +824,7 @@ SwaggerUi.partials.signature = (function () {
} }
function getInfiniteLoopMessage (name) { function getInfiniteLoopMessage (name) {
return '<!-- Infinite loop to model ' + name + ' -->'; return '<!-- Infinite loop $ref:' + name + ' -->';
} }
function getErrorMessage () { function getErrorMessage () {
@@ -832,7 +832,10 @@ SwaggerUi.partials.signature = (function () {
} }
function createSchemaXML (name, definition, models, config) { function createSchemaXML (name, definition, models, config) {
var $ref = definition.$ref; var $ref = _.isObject(definition) ? definition.$ref : null;
var output, index;
config = config || {};
config.modelsToIgnore = config.modelsToIgnore || [];
var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models, config) var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models, config)
: getDescriptor(name, definition, models, config); : getDescriptor(name, definition, models, config);
@@ -842,14 +845,23 @@ SwaggerUi.partials.signature = (function () {
switch (descriptor.type) { switch (descriptor.type) {
case 'array': case 'array':
return createArrayXML(descriptor); output = createArrayXML(descriptor); break;
case 'object': case 'object':
return createObjectXML(descriptor); output = createObjectXML(descriptor); break;
case 'loop': case 'loop':
return getInfiniteLoopMessage(descriptor.name); output = getInfiniteLoopMessage(descriptor.name); break;
default: default:
return createPrimitiveXML(descriptor); output = createPrimitiveXML(descriptor);
} }
if ($ref) {
index = config.modelsToIgnore.indexOf($ref);
if (index > -1) {
config.modelsToIgnore.splice(index, 1);
}
}
return output;
} }
function Descriptor (name, type, definition, models, config) { function Descriptor (name, type, definition, models, config) {
@@ -871,12 +883,10 @@ SwaggerUi.partials.signature = (function () {
var name = model.name || modelType; var name = model.name || modelType;
var type = model.type || 'object'; var type = model.type || 'object';
config = config || {}; if (config.modelsToIgnore.indexOf($ref) > -1) {
config.modelsToIgnore = config.modelsToIgnore || [];
if (config.modelsToIgnore.indexOf(name) > -1) {
type = 'loop'; type = 'loop';
} else { } else {
config.modelsToIgnore.push(modelType); config.modelsToIgnore.push($ref);
} }
if (!model.definition) { if (!model.definition) {

74
test/unit/view/partials/signatureSpec.js
View File

@@ -502,7 +502,7 @@ describe('SwaggerUi.partials.signature tests', function () {
} }
}; };
expect(sut.createSchemaXML(name, definition, models, true)).to.equal(expected); expect(sut.createSchemaXML(name, definition, models, {isParam: true})).to.equal(expected);
}); });
}); });
@@ -554,7 +554,7 @@ describe('SwaggerUi.partials.signature tests', function () {
'<id>1</id>' + '<id>1</id>' +
'<Loop2>' + '<Loop2>' +
'<id>1</id>' + '<id>1</id>' +
'<!-- Infinite loop to model Loop1 -->' + '<!-- Infinite loop $ref:Loop1 -->' +
'</Loop2>' + '</Loop2>' +
'</Loop1>'; '</Loop1>';
var schema = { var schema = {
@@ -570,7 +570,7 @@ describe('SwaggerUi.partials.signature tests', function () {
'<id>1</id>' + '<id>1</id>' +
'<Loop2>' + '<Loop2>' +
'<id>1</id>' + '<id>1</id>' +
'<!-- Infinite loop to model Loop1 -->' + '<!-- Infinite loop $ref:Loop1 -->' +
'</Loop2>' + '</Loop2>' +
'</Loop1>' + '</Loop1>' +
'</Loop3>'; '</Loop3>';
@@ -580,6 +580,74 @@ describe('SwaggerUi.partials.signature tests', function () {
expect(sut.createSchemaXML('', schema, models)).to.equal(expected); expect(sut.createSchemaXML('', schema, models)).to.equal(expected);
}); });
it('infinite loop Loop1 => Loop2, Loop2 => Loop1 with 2 different loops on one level', function () {
var expected = '<Pet><Loop1>' +
'<id>1</id>' +
'<Loop2>' +
'<id>1</id>' +
'<!-- Infinite loop $ref:Loop1 -->' +
'</Loop2>' +
'</Loop1>' +
'<Loop2>' +
'<id>1</id>' +
'<Loop1>' +
'<id>1</id>' +
'<!-- Infinite loop $ref:Loop2 -->' +
'</Loop1>' +
'</Loop2>' +
'</Pet>';
var schema = {
type: 'object',
properties: {
item1: {
$ref: '#/definitions/Loop1'
},
item2: {
$ref: '#/definitions/Loop2'
}
},
xml: {
name: 'Pet'
}
};
expect(sut.createSchemaXML('', schema, models)).to.equal(expected);
});
it('infinite loop Loop1 => Loop2, Loop2 => Loop1 with 2 different loops on one level', function () {
var expected = '<Pet><Loop1>' +
'<id>1</id>' +
'<Loop2>' +
'<id>1</id>' +
'<!-- Infinite loop $ref:Loop1 -->' +
'</Loop2>' +
'</Loop1>' +
'<Loop1>' +
'<id>1</id>' +
'<Loop2>' +
'<id>1</id>' +
'<!-- Infinite loop $ref:Loop1 -->' +
'</Loop2>' +
'</Loop1>' +
'</Pet>';
var schema = {
type: 'object',
properties: {
item1: {
$ref: '#/definitions/Loop1'
},
item2: {
$ref: '#/definitions/Loop1'
}
},
xml: {
name: 'Pet'
}
};
expect(sut.createSchemaXML('', schema, models)).to.equal(expected);
});
}); });
}); });
}); });