Merge "[api-ref] Added template-function-list"

This commit is contained in:
Jenkins 2016-06-01 11:34:13 +00:00 committed by Gerrit Code Review
commit 67e6f20967
3 changed files with 78 additions and 0 deletions

View File

@ -70,6 +70,12 @@ type_name:
in: path
required: false
type: string
template_version:
description: |
The version of the heat template.
in: path
required: true
type: string
# variables in query
action_3:

View File

@ -0,0 +1,44 @@
{
"template_functions": [
{
"functions": "Fn::Select",
"description": "A function for selecting an item from a list or map."
},
{
"functions": "repeat",
"description": "A function for iterating over a list of items."
},
{
"functions": "resource_facade",
"description": "A function for retrieving data in a parent provider template."
},
{
"functions": "list_join",
"description": "A function for joining strings."
},
{
"functions": "str_replace",
"description": "A function for performing string substitutions."
},
{
"functions": "get_attr",
"description": "A function for resolving resource attributes."
},
{
"functions": "get_param",
"description": "A function for resolving parameter references."
},
{
"functions": "get_file",
"description": "A function for including a file inline."
},
{
"functions": "digest",
"description": "A function for performing digest operations."
},
{
"functions": "get_resource",
"description": "A function for resolving resource references."
}
]
}

View File

@ -4,6 +4,34 @@
Templates
=========
List template functions
=======================
.. rest_method:: GET /v1/{tenant_id}/template_versions/{template_version}/functions
Lists all available functions for a template version.
Normal response codes: 200
Error response codes:401,400,
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- template_version: template_version
Response Example
----------------
.. literalinclude:: samples/template-functions-list-response.json
:language: javascript