Skip to content

Commit 9e7124e

Browse files
hotlonghotlong
committed
Add automation, driver, and permission schema docs
Introduces new documentation files for automation flows, workflows, drivers (including Mongo and Postgres), and permission/sharing rules. Updates validation documentation to clarify 'events' as 'Validation contexts' instead of 'Trigger contexts'. Refactors driver-related docs into a new structure and removes/deletes old JSON schema files for data drivers and permission triggers.
1 parent eef7d27 commit 9e7124e

File tree

83 files changed

+615
-733
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+615
-733
lines changed

‎content/docs/references/automation/flow/Flow.mdx‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Flow
3+
description: Flow Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **name** | `string` | ✅ | Machine name |
11+
| **label** | `string` | ✅ | Flow label |
12+
| **description** | `string` | optional | |
13+
| **version** | `integer` | optional | Version number |
14+
| **status** | `Enum<'draft' \| 'active' \| 'obsolete' \| 'invalid'>` | optional | Deployment status |
15+
| **template** | `boolean` | optional | Is logic template (Subflow) |
16+
| **type** | `Enum<'autolaunched' \| 'record_change' \| 'schedule' \| 'screen' \| 'api'>` | ✅ | Flow type |
17+
| **variables** | `object[]` | optional | Flow variables |
18+
| **nodes** | `object[]` | ✅ | Flow nodes |
19+
| **edges** | `object[]` | ✅ | Flow connections |
20+
| **active** | `boolean` | optional | Is active (Deprecated: use status) |
21+
| **runAs** | `Enum<'system' \| 'user'>` | optional | Execution context |

‎content/docs/references/automation/flow/FlowEdge.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: FlowEdge
3+
description: FlowEdge Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **id** | `string` | ✅ | Edge unique ID |
11+
| **source** | `string` | ✅ | Source Node ID |
12+
| **target** | `string` | ✅ | Target Node ID |
13+
| **condition** | `string` | optional | Expression returning boolean used for branching |
14+
| **type** | `Enum<'default' \| 'fault'>` | optional | Connection type: Standard (Success) or Fault (Error) path |
15+
| **label** | `string` | optional | Label on the connector |

‎content/docs/references/automation/flow/FlowNode.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: FlowNode
3+
description: FlowNode Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **id** | `string` | ✅ | Node unique ID |
11+
| **type** | `Enum<'start' \| 'end' \| 'decision' \| 'assignment' \| 'loop' \| 'create_record' \| 'update_record' \| 'delete_record' \| 'get_record' \| 'http_request' \| 'script' \| 'wait' \| 'subflow'>` | ✅ | Action type |
12+
| **label** | `string` | ✅ | Node label |
13+
| **config** | `Record<string, any>` | optional | Node configuration |
14+
| **position** | `object` | optional | |

‎content/docs/references/automation/flow/FlowNodeAction.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: FlowNodeAction
3+
description: FlowNodeAction Schema Reference
4+
---
5+
6+
## Allowed Values
7+
8+
* `start`
9+
* `end`
10+
* `decision`
11+
* `assignment`
12+
* `loop`
13+
* `create_record`
14+
* `update_record`
15+
* `delete_record`
16+
* `get_record`
17+
* `http_request`
18+
* `script`
19+
* `wait`
20+
* `subflow`

‎content/docs/references/automation/flow/FlowVariable.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: FlowVariable
3+
description: FlowVariable Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **name** | `string` | ✅ | Variable name |
11+
| **type** | `string` | ✅ | Data type (text, number, boolean, object, list) |
12+
| **isInput** | `boolean` | optional | Is input parameter |
13+
| **isOutput** | `boolean` | optional | Is output parameter |

‎content/docs/references/automation/flow/meta.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"title": "Flows"
3+
}

‎content/docs/references/automation/meta.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"title": "Automation Protocol",
3+
"root": true,
4+
"pages": [
5+
"flow",
6+
"workflow"
7+
]
8+
}

‎content/docs/references/automation/workflow/CustomScriptAction.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: CustomScriptAction
3+
description: CustomScriptAction Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **name** | `string` | ✅ | Action name |
11+
| **type** | `string` | ✅ | |
12+
| **language** | `Enum<'javascript' \| 'typescript' \| 'python'>` | optional | Script language |
13+
| **code** | `string` | ✅ | Script code to execute |
14+
| **timeout** | `number` | optional | Execution timeout in milliseconds |
15+
| **context** | `Record<string, any>` | optional | Additional context variables |

‎content/docs/references/automation/workflow/EmailAlertAction.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: EmailAlertAction
3+
description: EmailAlertAction Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **name** | `string` | ✅ | Action name |
11+
| **type** | `string` | ✅ | |
12+
| **template** | `string` | ✅ | Email template ID/DevName |
13+
| **recipients** | `string[]` | ✅ | List of recipient emails or user IDs |

‎content/docs/references/automation/workflow/FieldUpdateAction.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: FieldUpdateAction
3+
description: FieldUpdateAction Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **name** | `string` | ✅ | Action name |
11+
| **type** | `string` | ✅ | |
12+
| **field** | `string` | ✅ | Field to update |
13+
| **value** | `any` | optional | Value or Formula to set |

0 commit comments

Comments
 (0)