Skip to content

Commit caf56e8

Browse files
committed
Add JSON schema definitions for various system and UI components
- Created MongoConfig.json for MongoDB configuration settings. - Added ObjectQLClient.json for ObjectQL data access client definition. - Introduced Plugin.json for plugin metadata structure. - Defined PluginContext.json for plugin context properties and requirements. - Added PluginLifecycle.json for plugin lifecycle management. - Created PostgresConfig.json for PostgreSQL configuration settings. - Introduced Router.json for HTTP router interface definition. - Added RuntimeMode.json for kernel operating modes. - Created Scheduler.json for job scheduler interface definition. - Defined ScopedStorage.json for plugin scoped data storage. - Added ScopedStorageConfig.json for scoped storage configuration settings. - Introduced StorageAdapterType.json for storage adapter types. - Created StorageScope.json for generic storage scope classification. - Added SystemAPI.json for access to system core functionalities. - Created PageCardProps.json for page card properties definition. - Introduced PageComponentType.json for page component types. - Added PageHeaderProps.json for page header properties definition. - Created PageTabsProps.json for page tabs properties definition. - Introduced RecordDetailsProps.json for record details properties. - Added RecordHighlightsProps.json for record highlights properties. - Created RecordRelatedListProps.json for related list properties.
1 parent 0be9bbf commit caf56e8

File tree

131 files changed

+1865
-50
lines changed

Some content is hidden

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

131 files changed

+1865
-50
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: ApprovalAction
3+
description: ApprovalAction Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **type** | `Enum<'field_update' \| 'email_alert' \| 'webhook' \| 'script'>` || |
11+
| **name** | `string` || Action name |
12+
| **config** | `Record<string, any>` || Action configuration |
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: ApprovalActionType
3+
description: ApprovalActionType Schema Reference
4+
---
5+
6+
## Allowed Values
7+
8+
* `field_update`
9+
* `email_alert`
10+
* `webhook`
11+
* `script`
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: ApprovalProcess
3+
description: ApprovalProcess Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **name** | `string` || Unique process name |
11+
| **label** | `string` || Human readable label |
12+
| **object** | `string` || Target Object Name |
13+
| **active** | `boolean` | optional | |
14+
| **description** | `string` | optional | |
15+
| **entryCriteria** | `string` | optional | Formula to allow submission |
16+
| **lockRecord** | `boolean` | optional | Lock record from editing during approval |
17+
| **steps** | `object[]` || Sequence of approval steps |
18+
| **onSubmit** | `object[]` | optional | Actions on initial submission |
19+
| **onFinalApprove** | `object[]` | optional | Actions on final approval |
20+
| **onFinalReject** | `object[]` | optional | Actions on final rejection |
21+
| **onRecall** | `object[]` | optional | Actions on recall |
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: ApprovalStep
3+
description: ApprovalStep Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **name** | `string` || Step machine name |
11+
| **label** | `string` || Step display label |
12+
| **description** | `string` | optional | |
13+
| **entryCriteria** | `string` | optional | Formula expression to enter this step |
14+
| **approvers** | `object[]` || List of allowed approvers |
15+
| **behavior** | `Enum<'first_response' \| 'unanimous'>` | optional | How to handle multiple approvers |
16+
| **rejectionBehavior** | `Enum<'reject_process' \| 'back_to_previous'>` | optional | What happens if rejected |
17+
| **onApprove** | `object[]` | optional | Actions on step approval |
18+
| **onReject** | `object[]` | optional | Actions on step rejection |
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: ApproverType
3+
description: ApproverType Schema Reference
4+
---
5+
6+
## Allowed Values
7+
8+
* `user`
9+
* `role`
10+
* `manager`
11+
* `field`
12+
* `queue`
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"title": "Approval"
3+
}

content/docs/references/automation/meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"title": "Automation Protocol",
33
"pages": [
4+
"approval",
45
"flow",
56
"webhook",
67
"workflow"

content/docs/references/data/field/Field.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Field Schema Reference
99
| :--- | :--- | :--- | :--- |
1010
| **name** | `string` | optional | Machine name (snake_case) |
1111
| **label** | `string` | optional | Human readable label |
12-
| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'markdown' \| 'html' \| 'richtext' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'select' \| 'lookup' \| 'master_detail' \| 'image' \| 'file' \| 'avatar' \| 'formula' \| 'summary' \| 'autonumber' \| 'location' \| 'geolocation' \| 'address' \| 'code' \| 'color' \| 'rating' \| 'slider' \| 'signature' \| 'qrcode'>` || Field Data Type |
12+
| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'markdown' \| 'html' \| 'richtext' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'toggle' \| 'select' \| 'multiselect' \| 'radio' \| 'checkboxes' \| 'lookup' \| 'master_detail' \| 'tree' \| 'image' \| 'file' \| 'avatar' \| 'video' \| 'audio' \| 'formula' \| 'summary' \| 'autonumber' \| 'location' \| 'address' \| 'code' \| 'json' \| 'color' \| 'rating' \| 'slider' \| 'signature' \| 'qrcode' \| 'progress' \| 'tags'>` || Field Data Type |
1313
| **description** | `string` | optional | Tooltip/Help text |
1414
| **format** | `string` | optional | Format string (e.g. email, phone) |
1515
| **required** | `boolean` | optional | Is required |

content/docs/references/data/field/FieldType.mdx

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,30 @@ description: FieldType Schema Reference
2121
* `datetime`
2222
* `time`
2323
* `boolean`
24+
* `toggle`
2425
* `select`
26+
* `multiselect`
27+
* `radio`
28+
* `checkboxes`
2529
* `lookup`
2630
* `master_detail`
31+
* `tree`
2732
* `image`
2833
* `file`
2934
* `avatar`
35+
* `video`
36+
* `audio`
3037
* `formula`
3138
* `summary`
3239
* `autonumber`
3340
* `location`
34-
* `geolocation`
3541
* `address`
3642
* `code`
43+
* `json`
3744
* `color`
3845
* `rating`
3946
* `slider`
4047
* `signature`
41-
* `qrcode`
48+
* `qrcode`
49+
* `progress`
50+
* `tags`
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: MongoConfig
3+
description: MongoConfig Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **url** | `string` | optional | Connection URI |
11+
| **database** | `string` || Database Name |
12+
| **host** | `string` | optional | Host address |
13+
| **port** | `number` | optional | Port number |
14+
| **username** | `string` | optional | Auth User |
15+
| **password** | `string` | optional | Auth Password |
16+
| **authSource** | `string` | optional | Authentication Database |
17+
| **ssl** | `boolean` | optional | Enable SSL |
18+
| **replicaSet** | `string` | optional | Replica Set Name |
19+
| **readPreference** | `Enum<'primary' \| 'primaryPreferred' \| 'secondary' \| 'secondaryPreferred' \| 'nearest'>` | optional | Read Preference |
20+
| **maxPoolSize** | `number` | optional | Max Connection Pool Size |
21+
| **minPoolSize** | `number` | optional | Min Connection Pool Size |
22+
| **connectTimeoutMS** | `number` | optional | Connection Timeout (ms) |
23+
| **socketTimeoutMS** | `number` | optional | Socket Timeout (ms) |

0 commit comments

Comments
 (0)