DeforaNetworks/corteza
3
0
Fork 0
Code Activity

Add REST API endpoints for manual automation script triggering

Browse Source
This commit is contained in:
Denis Arh
2020-01-18 07:05:34 +01:00
parent 7491936742
commit ebb9b70bfe
49 changed files with 2578 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/compose/spec.json
+147
View File
@@ -167,6 +167,30 @@
}
]
}
},
{
"name": "fireTrigger",
"method": "POST",
"title": "Fire compose:namespace trigger",
"path": "/{namespaceID}/trigger",
"parameters": {
"path": [
{
"type": "uint64",
"name": "namespaceID",
"required": true,
"title": "ID"
}
],
"post": [
{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}
]
}
}
]
},
@@ -438,6 +462,30 @@
}
]
}
},
{
"name": "fireTrigger",
"method": "POST",
"title": "Fire compose:page trigger",
"path": "/{pageID}/trigger",
"parameters": {
"path": [
{
"type": "uint64",
"name": "pageID",
"required": true,
"title": "Page ID"
}
],
"post": [
{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}
]
}
}
]
},
@@ -626,6 +674,30 @@
}
]
}
},
{
"name": "fireTrigger",
"method": "POST",
"title": "Fire compose:module trigger",
"path": "/{moduleID}/trigger",
"parameters": {
"path": [
{
"type": "uint64",
"name": "moduleID",
"required": true,
"title": "ID"
}
],
"post": [
{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}
]
}
}
]
},
@@ -942,6 +1014,30 @@
}
]
}
},
{
"name": "trigger",
"method": "POST",
"title": "Fire compose:record trigger",
"path": "/{recordID}/trigger",
"parameters": {
"path": [
{
"type": "uint64",
"name": "recordID",
"required": true,
"title": "ID"
}
],
"post": [
{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}
]
}
}
]
},
@@ -1510,5 +1606,56 @@
"path": "/current"
}
]
},
{
"title": "Compose automation scripts",
"path": "/automation",
"entrypoint": "automation",
"apis": [
{
"name": "list",
"method": "GET",
"title": "List all available automation scripts for compose resources",
"path": "/",
"parameters": {
"get": [
{
"name": "resourceTypes",
"type": "[]string",
"title": "Filter by resource type"
},
{
"name": "eventTypes",
"type": "[]string",
"title": "Filter by event type"
},
{
"name": "excludeClientScripts",
"type": "bool",
"title": "Do not include client scripts"
},
{
"name": "excludeServerScripts",
"type": "bool",
"title": "Do not include server scripts"
}
]
}
},
{
"name": "trigger",
"method": "POST",
"title": "Triggers execution of a specific script on a system service level",
"path": "/trigger",
"parameters": {
"post": [{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}]
}
}
]
}
]
api/compose/spec/automation.json
+57
View File
@@ -0,0 +1,57 @@
{
"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": "resourceTypes",
"title": "Filter by resource type",
"type": "[]string"
},
{
"name": "eventTypes",
"title": "Filter by event type",
"type": "[]string"
},
{
"name": "excludeClientScripts",
"title": "Do not include client scripts",
"type": "bool"
},
{
"name": "excludeServerScripts",
"title": "Do not include server scripts",
"type": "bool"
}
]
}
},
{
"Name": "trigger",
"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"
}
]
}
}
]
}
api/compose/spec/module.json
+24
View File
@@ -184,6 +184,30 @@
}
]
}
},
{
"Name": "fireTrigger",
"Method": "POST",
"Title": "Fire compose:module trigger",
"Path": "/{moduleID}/trigger",
"Parameters": {
"path": [
{
"name": "moduleID",
"required": true,
"title": "ID",
"type": "uint64"
}
],
"post": [
{
"name": "script",
"required": true,
"title": "Script to execute",
"type": "string"
}
]
}
}
]
}
api/compose/spec/namespace.json
+24
View File
@@ -167,6 +167,30 @@
}
]
}
},
{
"Name": "fireTrigger",
"Method": "POST",
"Title": "Fire compose:namespace trigger",
"Path": "/{namespaceID}/trigger",
"Parameters": {
"path": [
{
"name": "namespaceID",
"required": true,
"title": "ID",
"type": "uint64"
}
],
"post": [
{
"name": "script",
"required": true,
"title": "Script to execute",
"type": "string"
}
]
}
}
]
}
api/compose/spec/page.json
+24
View File
@@ -267,6 +267,30 @@
}
]
}
},
{
"Name": "fireTrigger",
"Method": "POST",
"Title": "Fire compose:page trigger",
"Path": "/{pageID}/trigger",
"Parameters": {
"path": [
{
"name": "pageID",
"required": true,
"title": "Page ID",
"type": "uint64"
}
],
"post": [
{
"name": "script",
"required": true,
"title": "Script to execute",
"type": "string"
}
]
}
}
]
}
api/compose/spec/record.json
+24
View File
@@ -312,6 +312,30 @@
}
]
}
},
{
"Name": "trigger",
"Method": "POST",
"Title": "Fire compose:record trigger",
"Path": "/{recordID}/trigger",
"Parameters": {
"path": [
{
"name": "recordID",
"required": true,
"title": "ID",
"type": "uint64"
}
],
"post": [
{
"name": "script",
"required": true,
"title": "Script to execute",
"type": "string"
}
]
}
}
]
}
api/system/spec.json
+123
View File
@@ -716,6 +716,30 @@
}
]
}
},
{
"name": "fireTrigger",
"method": "POST",
"title": "Fire system:role trigger",
"path": "/{roleID}/trigger",
"parameters": {
"path": [
{
"type": "uint64",
"name": "roleID",
"required": true,
"title": "ID"
}
],
"post": [
{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}
]
}
}
]
},
@@ -1069,6 +1093,30 @@
}
]
}
},
{
"name": "fireTrigger",
"method": "POST",
"title": "Fire system:user trigger",
"path": "/{userID}/trigger",
"parameters": {
"path": [
{
"type": "uint64",
"name": "userID",
"required": true,
"title": "ID"
}
],
"post": [
{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}
]
}
}
]
},
@@ -1254,6 +1302,30 @@
}
]
}
},
{
"name": "fireTrigger",
"method": "POST",
"title": "Fire system:application trigger",
"path": "/{applicationID}/trigger",
"parameters": {
"path": [
{
"type": "uint64",
"name": "applicationID",
"required": true,
"title": "ID"
}
],
"post": [
{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}
]
}
}
]
},
@@ -1609,5 +1681,56 @@
"parameters": {}
}
]
},
{
"title": "System automation scripts",
"path": "/automation",
"entrypoint": "automation",
"apis": [
{
"name": "list",
"method": "GET",
"title": "List all available automation scripts for system resources",
"path": "/",
"parameters": {
"get": [
{
"name": "resourceTypes",
"type": "[]string",
"title": "Filter by resource type"
},
{
"name": "eventTypes",
"type": "[]string",
"title": "Filter by event type"
},
{
"name": "excludeClientScripts",
"type": "bool",
"title": "Do not include client scripts"
},
{
"name": "excludeServerScripts",
"type": "bool",
"title": "Do not include server scripts"
}
]
}
},
{
"name": "trigger",
"method": "POST",
"title": "Triggers execution of a specific script on a system service level",
"path": "/trigger",
"parameters": {
"post": [{
"name": "script",
"type": "string",
"title": "Script to execute",
"required": true
}]
}
}
]
}
]
api/system/spec/application.json
+24
View File
@@ -182,6 +182,30 @@
}
]
}
},
{
"Name": "fireTrigger",
"Method": "POST",
"Title": "Fire system:application trigger",
"Path": "/{applicationID}/trigger",
"Parameters": {
"path": [
{
"name": "applicationID",
"required": true,
"title": "ID",
"type": "uint64"
}
],
"post": [
{
"name": "script",
"required": true,
"title": "Script to execute",
"type": "string"
}
]
}
}
]
}
api/system/spec/automation.json
+57
View File
@@ -0,0 +1,57 @@
{
"Title": "System 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 system resources",
"Path": "/",
"Parameters": {
"get": [
{
"name": "resourceTypes",
"title": "Filter by resource type",
"type": "[]string"
},
{
"name": "eventTypes",
"title": "Filter by event type",
"type": "[]string"
},
{
"name": "excludeClientScripts",
"title": "Do not include client scripts",
"type": "bool"
},
{
"name": "excludeServerScripts",
"title": "Do not include server scripts",
"type": "bool"
}
]
}
},
{
"Name": "trigger",
"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"
}
]
}
}
]
}
api/system/spec/role.json
+24
View File
@@ -308,6 +308,30 @@
}
]
}
},
{
"Name": "fireTrigger",
"Method": "POST",
"Title": "Fire system:role trigger",
"Path": "/{roleID}/trigger",
"Parameters": {
"path": [
{
"name": "roleID",
"required": true,
"title": "ID",
"type": "uint64"
}
],
"post": [
{
"name": "script",
"required": true,
"title": "Script to execute",
"type": "string"
}
]
}
}
]
}
api/system/spec/user.json
+24
View File
@@ -350,6 +350,30 @@
}
]
}
},
{
"Name": "fireTrigger",
"Method": "POST",
"Title": "Fire system:user trigger",
"Path": "/{userID}/trigger",
"Parameters": {
"path": [
{
"name": "userID",
"required": true,
"title": "ID",
"type": "uint64"
}
],
"post": [
{
"name": "script",
"required": true,
"title": "Script to execute",
"type": "string"
}
]
}
}
]
}