| 1 | [% if entry.functions %] |
| 2 | ## Live Data |
| 3 | |
| 4 | [[ entry.functions.description ]] |
| 5 | |
| 6 | [% for func in entry.functions.list %] |
| 7 | ### [[ func.name ]] |
| 8 | |
| 9 | [[ func.description ]] |
| 10 | |
| 11 | | Aspect | Description | |
| 12 | |:-------|:------------| |
| 13 | | Name | `[[ strfy(entry.meta.module_name)|capitalize ]]:[[ strfy(func.id) ]]` | |
| 14 | | Require Cloud | [[ 'yes' if func.require_cloud else 'no' ]] | |
| 15 | | Performance | [[ strfy(func.performance) ]] | |
| 16 | | Security | [[ strfy(func.security) ]] | |
| 17 | | Availability | [[ strfy(func.availability) ]] | |
| 18 | |
| 19 | #### Prerequisites |
| 20 | |
| 21 | [% if func.prerequisites and func.prerequisites.list %] |
| 22 | [% for req in func.prerequisites.list %] |
| 23 | ##### [[ req.title ]] |
| 24 | |
| 25 | [[ req.description ]] |
| 26 | |
| 27 | [% endfor %] |
| 28 | [% else %] |
| 29 | No additional configuration is required. |
| 30 | [% endif %] |
| 31 | |
| 32 | #### Parameters |
| 33 | |
| 34 | [% if func.parameters %] |
| 35 | | Parameter | Type | Description | Required | Default | Options | |
| 36 | |:---------|:-----|:------------|:--------:|:--------|:--------| |
| 37 | [% for param in func.parameters %] |
| 38 | | [[ strfy(param.name) ]] | [[ strfy(param.type) ]] | [[ strfy(param.description) ]] | [[ strfy(param.required) ]] | [[ strfy(param.default) ]] | [% if param.options %][% for opt in param.options %][[ strfy(opt.name) ]][% if opt.default %] (default)[% endif %][% if not loop.last %], [% endif %][% endfor %][% endif %] | |
| 39 | [% endfor %] |
| 40 | [% else %] |
| 41 | This function has no parameters. |
| 42 | [% endif %] |
| 43 | |
| 44 | #### Returns |
| 45 | |
| 46 | [[ func.returns.description ]] |
| 47 | |
| 48 | | Column | Type | Unit | Visibility | Description | |
| 49 | |:-------|:-----|:-----|:-----------|:------------| |
| 50 | [% for col in func.returns.columns %] |
| 51 | | [[ strfy(col.name) ]] | [[ strfy(col.type) ]] | [[ strfy(col.unit) ]] | [[ strfy(col.visibility) ]] | [[ strfy(col.description) ]] | |
| 52 | [% endfor %] |
| 53 | |
| 54 | [% endfor %] |
| 55 | [% endif %] |