Ext.define('pve-param-schema', {
extend: 'Ext.data.Model',
fields: [
- 'name', 'type', 'typetext', 'description', 'enum',
- 'minimum', 'maximum', 'minLength', 'maxLength',
+ 'name', 'type', 'typetext', 'description', 'verbose_description',
+ 'enum', 'minimum', 'maximum', 'minLength', 'maxLength',
'pattern', 'title', 'requires', 'format', 'default',
'disallow', 'extends', 'links',
{
}]
});
- var render_text = function(value, metaData, record) {
+ var render_description = function(value, metaData, record) {
var pdef = record.data;
+ value = pdef.verbose_description || value;
+
+ // TODO: try to render asciidoc correctly
+
metaData.style = 'white-space:pre-wrap;'
return Ext.htmlEncode(value);
stripeRows: true
},
columns: [
- {
+ {
header: 'Name',
- dataIndex: 'name'
+ dataIndex: 'name',
+ flex: 1
},
- {
+ {
header: 'Type',
dataIndex: 'type',
renderer: render_type,
+ flex: 1
+ },
+ {
+ header: 'Default',
+ dataIndex: 'default',
+ flex: 1
},
- {
+ {
header: 'Format',
dataIndex: 'type',
renderer: render_format,
- flex: 1
+ flex: 2
},
- {
+ {
header: 'Description',
dataIndex: 'description',
- renderer: render_text,
- flex: 2
+ renderer: render_description,
+ flex: 6
}
]
});
if (info.returns) {
- var rtype = info.returns.type;
- if (!rtype && info.returns.items)
+ var retinf = info.returns;
+ var rtype = retinf.type;
+ if (!rtype && retinf.items)
rtype = 'array';
if (!rtype)
rtype = 'object';
+ var returnhtml;
+ if (retinf.items) {
+ returnhtml = '<pre>items: ' + JSON.stringify(retinf.items, null, 4) + '</pre>';
+ }
+
+ if (retinf.properties) {
+ returnhtml = returnhtml || '';
+ returnhtml += '<pre>properties:' + JSON.stringify(retinf.properties, null, 4);
+ }
+
sections.push({
- title: 'Returns: ' + rtype
+ title: 'Returns: ' + rtype,
+ html: returnhtml
});
}
if (info.permissions.user) {
if (!info.permissions.description) {
if (info.permissions.user === 'world') {
- permhtml += "Accessible without any authententification.";
+ permhtml += "Accessible without any authentication.";
} else if (info.permissions.user === 'all') {
- permhtml += "Accessible by all authententicated users.";
+ permhtml += "Accessible by all authenticated users.";
} else {
permhtml += 'Onyl accessible by user "' +
info.permissions.user + '"';