Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add simple documentation for methods without bodyParam 

post, put and patch requests without a bodyParam will now be documented
with an undocumented bodyParam. This will allow people to try out this
undocumented field in the Swagger documentation in the admin interface.
This commit is contained in:
Lucas Dohmen 2014-06-18 17:31:11 +02:00
parent ea9ea54de5
commit b9d4a96652
2 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
js/server/modules/org/arangodb/foxx/controller.js
View File

@ -174,6 +174,11 @@ extend(Controller.prototype, {
this.applicationContext.clearComments();
if (method === 'post' || method === 'put' || method === 'patch') {
var UndocumentedBody = require('org/arangodb/foxx').Model.extend();
requestContext.bodyParam("undocumented body", "Undocumented body param", UndocumentedBody);
}
return requestContext;
},

20
js/server/modules/org/arangodb/foxx/request_context.js
View File

@ -144,12 +144,22 @@ extend(SwaggerDocs.prototype, {
'use strict';
this.models[jsonSchema.id] = jsonSchema;
this.docs.parameters.push({
name: paramName,
paramType: "body",
description: description,
dataType: jsonSchema.id
var param = _.find(this.docs.parameters, function (parameter) {
return parameter.name === 'undocumented body';
});
if (_.isUndefined(param)) {
this.docs.parameters.push({
name: paramName,
paramType: "body",
description: description,
dataType: jsonSchema.id
});
} else {
param.name = paramName;
param.description = description;
param.dataType = jsonSchema.id;
}
},
addSummary: function (summary) {