merged
This commit is contained in:
1293
dist/swagger-ui.js
vendored
1293
dist/swagger-ui.js
vendored
File diff suppressed because one or more lines are too long
22
dist/swagger-ui.min.js
vendored
22
dist/swagger-ui.min.js
vendored
File diff suppressed because one or more lines are too long
@@ -183,6 +183,10 @@ SwaggerUi.Views.OperationView = Backbone.View.extend({
|
||||
sampleXML: isXML ? SwaggerUi.partials.signature.createXMLSample(value.definition, value.models) : false,
|
||||
signature: SwaggerUi.partials.signature.getModelSignature(value.name, value.definition, value.models, value.modelPropertyMacro)
|
||||
};
|
||||
} else {
|
||||
signatureModel = {
|
||||
signature: SwaggerUi.partials.signature.getPrimitiveSignature(value)
|
||||
};
|
||||
}
|
||||
}
|
||||
} else if (this.model.responseClassSignature && this.model.responseClassSignature !== 'string') {
|
||||
|
||||
@@ -21,6 +21,7 @@ SwaggerUi.Views.ParameterView = Backbone.View.extend({
|
||||
var modelDefinitions = this.model.modelSignature.definitions;
|
||||
var schema = this.model.schema || {};
|
||||
var consumes = this.model.consumes || [];
|
||||
var sampleJSON, signatureView;
|
||||
|
||||
|
||||
if (typeof type === 'undefined') {
|
||||
@@ -53,20 +54,21 @@ SwaggerUi.Views.ParameterView = Backbone.View.extend({
|
||||
|
||||
var isXML = this.contains(consumes, 'xml');
|
||||
var isJSON = isXML ? this.contains(consumes, 'json') : true;
|
||||
sampleJSON = SwaggerUi.partials.signature.createParameterJSONSample(modelType, modelDefinitions);
|
||||
|
||||
var template = this.template();
|
||||
$(this.el).html(template(this.model));
|
||||
|
||||
var signatureModel = {
|
||||
sampleJSON: isJSON ? SwaggerUi.partials.signature.createParameterJSONSample(modelType, modelDefinitions) : false,
|
||||
sampleXML: isXML ? SwaggerUi.partials.signature.createXMLSample(schema, modelDefinitions, true) : false,
|
||||
sampleJSON: isJSON ? sampleJSON : false,
|
||||
sampleXML: sampleJSON && isXML ? SwaggerUi.partials.signature.createXMLSample(schema, modelDefinitions, true) : false,
|
||||
isParam: true,
|
||||
signature: SwaggerUi.partials.signature.getParameterModelSignature(modelType, modelDefinitions),
|
||||
defaultRendering: this.model.defaultRendering
|
||||
};
|
||||
|
||||
if (this.model.sampleJSON) {
|
||||
var signatureView = new SwaggerUi.Views.SignatureView({model: signatureModel, tagName: 'div'});
|
||||
if (sampleJSON) {
|
||||
signatureView = new SwaggerUi.Views.SignatureView({model: signatureModel, tagName: 'div'});
|
||||
$('.model-signature', $(this.el)).append(signatureView.render().el);
|
||||
}
|
||||
else {
|
||||
|
||||
@@ -7,23 +7,26 @@ SwaggerUi.Views.StatusCodeView = Backbone.View.extend({
|
||||
},
|
||||
|
||||
render: function(){
|
||||
var responseModel, responseModelView;
|
||||
var value = this.router.api.models[this.model.responseModel];
|
||||
$(this.el).html(Handlebars.templates.status_code(this.model));
|
||||
|
||||
if (this.router.api.models.hasOwnProperty(this.model.responseModel)) {
|
||||
var responseModel = {
|
||||
responseModel = {
|
||||
sampleJSON: JSON.stringify(SwaggerUi.partials.signature.createJSONSample(value), void 0, 2),
|
||||
sampleXML: this.model.isXML ? SwaggerUi.partials.signature.createXMLSample(this.model.schema, value.models) : false,
|
||||
sampleXML: this.model.isXML ? SwaggerUi.partials.signature.createXMLSample(this.model.schema, this.router.api.models) : false,
|
||||
isParam: false,
|
||||
signature: SwaggerUi.partials.signature.getModelSignature(this.model.responseModel, value, this.router.api.models),
|
||||
defaultRendering: this.model.defaultRendering
|
||||
};
|
||||
|
||||
var responseModelView = new SwaggerUi.Views.SignatureView({model: responseModel, tagName: 'div'});
|
||||
$('.model-signature', this.$el).append(responseModelView.render().el);
|
||||
} else {
|
||||
$('.model-signature', this.$el).html('');
|
||||
responseModel = {
|
||||
signature: SwaggerUi.partials.signature.getPrimitiveSignature(this.model.schema)
|
||||
};
|
||||
}
|
||||
|
||||
responseModelView = new SwaggerUi.Views.SignatureView({model: responseModel, tagName: 'div'});
|
||||
$('.model-signature', this.$el).append(responseModelView.render().el);
|
||||
return this;
|
||||
}
|
||||
});
|
||||
@@ -736,6 +736,20 @@ SwaggerUi.partials.signature = (function () {
|
||||
return value;
|
||||
};
|
||||
|
||||
var getPrimitiveSignature = function (schema) {
|
||||
var type, items;
|
||||
|
||||
schema = schema || {};
|
||||
items = schema.items || {};
|
||||
type = schema.type || '';
|
||||
|
||||
switch (type) {
|
||||
case 'object': return 'Object is not a primitive';
|
||||
case 'array' : return 'Array[' + (items.format || items.type) + ']';
|
||||
default: return schema.format || type;
|
||||
}
|
||||
};
|
||||
|
||||
var createPrimitiveXML = function (descriptor) {
|
||||
var name = descriptor.name;
|
||||
var definition = descriptor.definition;
|
||||
@@ -924,7 +938,8 @@ SwaggerUi.partials.signature = (function () {
|
||||
getParameterModelSignature: getParameterModelSignature,
|
||||
createParameterJSONSample: createParameterJSONSample,
|
||||
createSchemaXML: createSchemaXML,
|
||||
createXMLSample: createXMLSample
|
||||
createXMLSample: createXMLSample,
|
||||
getPrimitiveSignature: getPrimitiveSignature
|
||||
};
|
||||
|
||||
})();
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
{{#ifCond sampleJSON "||" sampleXML}}
|
||||
|
||||
<div>
|
||||
<ul class="signature-nav">
|
||||
<li><a class="description-link" href="#" data-sw-translate>Model</a></li>
|
||||
@@ -25,3 +27,6 @@
|
||||
{{/if}}
|
||||
</div>
|
||||
</div>
|
||||
{{else}}
|
||||
{{signature}}
|
||||
{{/ifCond}}
|
||||
@@ -650,4 +650,39 @@ describe('SwaggerUi.partials.signature tests', function () {
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('method getPrimitiveSignature', function () {
|
||||
it('returns warning message when type is object', function () {
|
||||
expect(sut.getPrimitiveSignature({type: 'object'})).to.equal('Object is not a primitive');
|
||||
});
|
||||
|
||||
it('returns array with items.format when passing array', function () {
|
||||
var schema = {
|
||||
type: 'array',
|
||||
items: {
|
||||
format: 'format',
|
||||
type: 'type'
|
||||
}
|
||||
};
|
||||
expect(sut.getPrimitiveSignature(schema)).to.equal('Array[format]');
|
||||
});
|
||||
|
||||
it('returns array with items.type when passing array without items.format', function () {
|
||||
var schema = {
|
||||
type: 'array',
|
||||
items: {
|
||||
type: 'type'
|
||||
}
|
||||
};
|
||||
expect(sut.getPrimitiveSignature(schema)).to.equal('Array[type]');
|
||||
});
|
||||
|
||||
it('returns format of primitive', function () {
|
||||
expect(sut.getPrimitiveSignature({type: 'type', format: 'format'})).to.equal('format');
|
||||
});
|
||||
|
||||
it('returns type of primitive if format is not passed', function () {
|
||||
expect(sut.getPrimitiveSignature({type: 'type'})).to.equal('type');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user