Returns the description of variables
GET/api/v2/templates/vars
Returns the description of variables
Request
Query Parameters
recurse string
will return all the nested objects
Responses
- 200
- 400
- 401
- 403
- 500
The variables available to a template
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
descriptionstring
examplesstring[]
includesundefined[]
namestring
onlyForstring
pathstringrequired
pathInContainerstring
pathToContainerstring
sourcestring
typestringrequired
[
{
"description": "string",
"examples": [
"string"
],
"includes": [
null
],
"name": "string",
"onlyFor": "string",
"path": "string",
"pathInContainer": "string",
"pathToContainer": "string",
"source": "string",
"type": "string"
}
]
Validation error of supplied parameters/body
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
codeint32required
fieldErrors
undefined[]
required
errCodestringrequired
fieldstringrequired
messagestringrequired
messagestringrequired
{
"code": 0,
"fieldErrors": [
{
"errCode": "string",
"field": "string",
"message": "string"
}
],
"message": "string"
}
If not authenticated
If authenticated but not authorized
A generic API error containing the cause of the error
- application/json
- Schema
- Example (from schema)
Schema
codeint32required
detailstringrequired
messagestringrequired
uristringrequired
verbstringrequired
{
"code": 0,
"detail": "string",
"message": "string",
"uri": "string",
"verb": "string"
}