habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] add more detailed type information for parameters

Browse Source
This commit is contained in:
spalger
2016-11-16 18:12:41 -07:00
parent f3bf5e08d0
commit 9fee381c8e
4 changed files with 41 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
scripts/generate/templates/api_methods.tmpl
View File

@ -37,7 +37,7 @@ var printParam = function (param, paramName) {
print(`\n\`${paramWithDefault(paramName, param.default)}\`::`)
// param type and description
print(`\n\`${paramType(param.type, paramName)}\` -- ${joinParagraphs(param.description || '', 4)}`)
print(`\n${paramType(param.type, paramName)} -- ${joinParagraphs(param.description || '', 4)}`)
if (param.type === 'enum') {
print('\nOptions:::')

2
scripts/generate/templates/docs_index.tmpl
View File

@ -36,3 +36,5 @@ include::host.asciidoc[]
include::transport.asciidoc[]
include::errors.asciidoc[]
include::api_param_types.asciidoc[]

22
scripts/generate/templates/index.js
View File

@ -69,20 +69,28 @@ var templateGlobals = {
paramType: function (type, paramName) {
switch (type && type.toLowerCase ? type.toLowerCase() : 'any') {
case 'time':
case 'duration':
if (paramName === 'timestamp') return 'Timestamp'
return 'DurationString';
return '<<api-param-type-duration-string,`DurationString`>>';
case 'any':
return 'Anything';
return 'anything';
case 'enum':
return 'String';
case 'string':
case 'text':
return '<<api-param-type-string,`String`>>';
case 'boolean':
return '<<api-param-type-boolean,`Boolean`>>';
case 'number':
case 'integer':
return '<<api-param-type-number,`Number`>>';
case 'list':
return 'String, String[], Boolean';
return '<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>';
case 'bulkbody':
return 'Object[], JSONLines';
return '<<api-param-type-object-array,`Object[]`>>, <<api-param-type-json-lines,`JSONLines`>>';
case 'body':
return 'Object, JSON';
return '<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>>';
default:
return _.ucfirst(type);
throw new Error(`unknown type "${type}"`);
}
},