3
0
corteza/api/compose/spec/automation.json
2020-01-22 18:07:49 +01:00

92 lines
2.2 KiB
JSON

{
"Title": "Compose automation scripts",
"Interface": "Automation",
"Struct": null,
"Parameters": null,
"Protocol": "",
"Authentication": null,
"Path": "/automation",
"APIs": [
{
"Name": "list",
"Method": "GET",
"Title": "List all available automation scripts for compose resources",
"Path": "/",
"Parameters": {
"get": [
{
"name": "resourceTypePrefixes",
"title": "Filter by resource prefix",
"type": "[]string"
},
{
"name": "resourceTypes",
"title": "Filter by resource type",
"type": "[]string"
},
{
"name": "eventTypes",
"title": "Filter by event type",
"type": "[]string"
},
{
"name": "excludeInvalid",
"title": "Exclude scripts that can not be used (errors)",
"type": "bool"
},
{
"name": "excludeClientScripts",
"title": "Do not include client scripts",
"type": "bool"
},
{
"name": "excludeServerScripts",
"title": "Do not include server scripts",
"type": "bool"
}
]
}
},
{
"Name": "bundle",
"Method": "GET",
"Title": "Serves client scripts bundle",
"Path": "/{bundle}-{type}.{ext}",
"Parameters": {
"path": [
{
"name": "bundle",
"title": "Name of the bundle",
"type": "string"
},
{
"name": "type",
"title": "Bundle type",
"type": "string"
},
{
"name": "ext",
"title": "Bundle extension",
"type": "string"
}
]
}
},
{
"Name": "triggerScript",
"Method": "POST",
"Title": "Triggers execution of a specific script on a system service level",
"Path": "/trigger",
"Parameters": {
"post": [
{
"name": "script",
"required": true,
"title": "Script to execute",
"type": "string"
}
]
}
}
]
}