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

#1248 createXMLSample Added handling readyOnly params

Browse Source
This commit is contained in:
Anna Bodnia
2016-01-18 13:50:21 +02:00
parent add91792fb
commit f68420051f
5 changed files with 57 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
dist/swagger-ui.js vendored
View File

@@ -26110,7 +26110,7 @@ SwaggerUi.Views.ParameterView = Backbone.View.extend({
var signatureModel = { var signatureModel = {
sampleJSON: SwaggerUi.partials.signature.createParameterJSONSample(modelType, modelDefinitions), sampleJSON: SwaggerUi.partials.signature.createParameterJSONSample(modelType, modelDefinitions),
sampleXML: isXML ? SwaggerUi.partials.signature.createXMLSample(schema, modelDefinitions) : false, sampleXML: isXML ? SwaggerUi.partials.signature.createXMLSample(schema, modelDefinitions, true) : false,
isParam: true, isParam: true,
signature: SwaggerUi.partials.signature.getParameterModelSignature(modelType, modelDefinitions), signature: SwaggerUi.partials.signature.getParameterModelSignature(modelType, modelDefinitions),
defaultRendering: this.model.defaultRendering defaultRendering: this.model.defaultRendering
@@ -26980,6 +26980,7 @@ SwaggerUi.partials.signature = (function () {
var name = descriptor.name; var name = descriptor.name;
var definition = descriptor.definition; var definition = descriptor.definition;
var models = descriptor.models; var models = descriptor.models;
var isParam = descriptor.isParam;
var serializedProperties; var serializedProperties;
var attrs = []; var attrs = [];
var properties = definition.properties; var properties = definition.properties;
@@ -26996,6 +26997,8 @@ SwaggerUi.partials.signature = (function () {
properties = properties || {}; properties = properties || {};
serializedProperties = _.map(properties, function (prop, key) { serializedProperties = _.map(properties, function (prop, key) {
if (isParam && prop.readOnly) { return ''; }
return createSchemaXML(key, prop, models); return createSchemaXML(key, prop, models);
}).join(''); }).join('');
@@ -27010,10 +27013,10 @@ SwaggerUi.partials.signature = (function () {
return '<!-- invalid XML -->'; return '<!-- invalid XML -->';
} }
function createSchemaXML (name, definition, models) { function createSchemaXML (name, definition, models, isParam) {
var $ref = definition.$ref; var $ref = definition.$ref;
var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models) var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models)
: getDescriptor(name, definition, models); : getDescriptor(name, definition, models, isParam);
if (!descriptor) { if (!descriptor) {
return getErrorMessage(); return getErrorMessage();
@@ -27029,7 +27032,7 @@ SwaggerUi.partials.signature = (function () {
} }
} }
function Descriptor (name, type, definition, models) { function Descriptor (name, type, definition, models, isParam) {
if (arguments.length < 4) { if (arguments.length < 4) {
throw new Error(); throw new Error();
} }
@@ -27038,6 +27041,7 @@ SwaggerUi.partials.signature = (function () {
this.definition = definition; this.definition = definition;
this.models = models; this.models = models;
this.type = type; this.type = type;
this.isParam = isParam;
} }
function getDescriptorByRef($ref, models) { function getDescriptorByRef($ref, models) {
@@ -27053,7 +27057,7 @@ SwaggerUi.partials.signature = (function () {
return new Descriptor (name, type, model.definition, models); return new Descriptor (name, type, model.definition, models);
} }
function getDescriptor (name, definition, models){ function getDescriptor (name, definition, models, isParam){
var type = definition.type || 'object'; var type = definition.type || 'object';
var xml = definition.xml || {}; var xml = definition.xml || {};
@@ -27063,13 +27067,13 @@ SwaggerUi.partials.signature = (function () {
name = getName(name, xml); name = getName(name, xml);
return new Descriptor(name, type, definition, models); return new Descriptor(name, type, definition, models,isParam);
} }
function createXMLSample (definition, models) { function createXMLSample (definition, models, isParam) {
var prolog = '<?xml version="1.0"?>'; var prolog = '<?xml version="1.0"?>';
return formatXml(prolog + createSchemaXML('', definition, models)); return formatXml(prolog + createSchemaXML('', definition, models, isParam));
} }
return { return {

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

File diff suppressed because one or more lines are too long

2
src/main/javascript/view/ParameterView.js
View File

@@ -58,7 +58,7 @@ SwaggerUi.Views.ParameterView = Backbone.View.extend({
var signatureModel = { var signatureModel = {
sampleJSON: SwaggerUi.partials.signature.createParameterJSONSample(modelType, modelDefinitions), sampleJSON: SwaggerUi.partials.signature.createParameterJSONSample(modelType, modelDefinitions),
sampleXML: isXML ? SwaggerUi.partials.signature.createXMLSample(schema, modelDefinitions) : false, sampleXML: isXML ? SwaggerUi.partials.signature.createXMLSample(schema, modelDefinitions, true) : false,
isParam: true, isParam: true,
signature: SwaggerUi.partials.signature.getParameterModelSignature(modelType, modelDefinitions), signature: SwaggerUi.partials.signature.getParameterModelSignature(modelType, modelDefinitions),
defaultRendering: this.model.defaultRendering defaultRendering: this.model.defaultRendering

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

@@ -776,6 +776,7 @@ SwaggerUi.partials.signature = (function () {
var name = descriptor.name; var name = descriptor.name;
var definition = descriptor.definition; var definition = descriptor.definition;
var models = descriptor.models; var models = descriptor.models;
var isParam = descriptor.isParam;
var serializedProperties; var serializedProperties;
var attrs = []; var attrs = [];
var properties = definition.properties; var properties = definition.properties;
@@ -792,6 +793,8 @@ SwaggerUi.partials.signature = (function () {
properties = properties || {}; properties = properties || {};
serializedProperties = _.map(properties, function (prop, key) { serializedProperties = _.map(properties, function (prop, key) {
if (isParam && prop.readOnly) { return ''; }
return createSchemaXML(key, prop, models); return createSchemaXML(key, prop, models);
}).join(''); }).join('');
@@ -806,10 +809,10 @@ SwaggerUi.partials.signature = (function () {
return '<!-- invalid XML -->'; return '<!-- invalid XML -->';
} }
function createSchemaXML (name, definition, models) { function createSchemaXML (name, definition, models, isParam) {
var $ref = definition.$ref; var $ref = definition.$ref;
var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models) var descriptor = _.isString($ref) ? getDescriptorByRef($ref, models)
: getDescriptor(name, definition, models); : getDescriptor(name, definition, models, isParam);
if (!descriptor) { if (!descriptor) {
return getErrorMessage(); return getErrorMessage();
@@ -825,7 +828,7 @@ SwaggerUi.partials.signature = (function () {
} }
} }
function Descriptor (name, type, definition, models) { function Descriptor (name, type, definition, models, isParam) {
if (arguments.length < 4) { if (arguments.length < 4) {
throw new Error(); throw new Error();
} }
@@ -834,6 +837,7 @@ SwaggerUi.partials.signature = (function () {
this.definition = definition; this.definition = definition;
this.models = models; this.models = models;
this.type = type; this.type = type;
this.isParam = isParam;
} }
function getDescriptorByRef($ref, models) { function getDescriptorByRef($ref, models) {
@@ -849,7 +853,7 @@ SwaggerUi.partials.signature = (function () {
return new Descriptor (name, type, model.definition, models); return new Descriptor (name, type, model.definition, models);
} }
function getDescriptor (name, definition, models){ function getDescriptor (name, definition, models, isParam){
var type = definition.type || 'object'; var type = definition.type || 'object';
var xml = definition.xml || {}; var xml = definition.xml || {};
@@ -859,13 +863,13 @@ SwaggerUi.partials.signature = (function () {
name = getName(name, xml); name = getName(name, xml);
return new Descriptor(name, type, definition, models); return new Descriptor(name, type, definition, models,isParam);
} }
function createXMLSample (definition, models) { function createXMLSample (definition, models, isParam) {
var prolog = '<?xml version="1.0"?>'; var prolog = '<?xml version="1.0"?>';
return formatXml(prolog + createSchemaXML('', definition, models)); return formatXml(prolog + createSchemaXML('', definition, models, isParam));
} }
return { return {

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

@@ -418,6 +418,30 @@ describe('SwaggerUi.partials.signature tests', function () {
expect(sut.createSchemaXML(name, definition, models)).to.equal(expected); expect(sut.createSchemaXML(name, definition, models)).to.equal(expected);
}); });
it('returns object with no readonly fields for parameter', function () {
var expected = '<animals>' +
'<id>1</id>'+
'</animals>';
var name = 'animals';
var definition = {
type: 'object',
properties: {
id: {
type: 'integer'
},
cat: {
readOnly: true,
type: 'string'
}
},
xml: {
name: 'animals'
}
};
expect(sut.createSchemaXML(name, definition, models, true)).to.equal(expected);
});
}); });
describe('schema is in definitions', function () { describe('schema is in definitions', function () {