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

Merge pull request #874 from triAGENS/foxx-doc-generator-improvements 

Foxx API Documentation explorer doesn't show POST/PUT/PATCH bodies without bodyParam
This commit is contained in:
Lucas Dohmen 2014-06-19 11:53:48 +02:00
parent dcf8ea97bf b9d4a96652
commit 049067dbc4
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(); 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; return requestContext;
}, },

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

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