Skip to content

Commit 7184fbb

Browse files
hotlonghotlong
authored
Merge pull request #81 from objectstack-ai/copilot/implement-realtime-sync-protocol
2 parents 48eea4a + bb07329 commit 7184fbb

Some content is hidden

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

49 files changed

+2746
-0
lines changed

‎content/docs/references/system/CronSchedule.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: CronSchedule
3+
description: CronSchedule Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **type** | `string` | ✅ | |
11+
| **expression** | `string` | ✅ | Cron expression (e.g., "0 0 * * *" for daily at midnight) |
12+
| **timezone** | `string` | optional | Timezone for cron execution (e.g., "America/New_York") |

‎content/docs/references/system/Event.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Event
3+
description: Event Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **name** | `string` | ✅ | Event name (snake_case with dots, e.g., user.created) |
11+
| **payload** | `any` | optional | Event payload schema |
12+
| **metadata** | `object` | ✅ | Event metadata |

‎content/docs/references/system/EventHandler.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: EventHandler
3+
description: EventHandler Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **eventName** | `string` | ✅ | Name of event to handle (supports wildcards like user.*) |
11+
| **priority** | `integer` | optional | Execution priority (lower numbers execute first) |
12+
| **async** | `boolean` | optional | Execute in background (true) or block (false) |

‎content/docs/references/system/EventMetadata.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: EventMetadata
3+
description: EventMetadata Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **source** | `string` | ✅ | Event source (e.g., plugin name, system component) |
11+
| **timestamp** | `string` | ✅ | ISO 8601 datetime when event was created |
12+
| **userId** | `string` | optional | User who triggered the event |
13+
| **tenantId** | `string` | optional | Tenant identifier for multi-tenant systems |

‎content/docs/references/system/EventPersistence.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: EventPersistence
3+
description: EventPersistence Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **enabled** | `boolean` | optional | Enable event persistence |
11+
| **retention** | `integer` | ✅ | Days to retain persisted events |

‎content/docs/references/system/EventRoute.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: EventRoute
3+
description: EventRoute Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **from** | `string` | ✅ | Source event pattern (supports wildcards, e.g., user.* or *.created) |
11+
| **to** | `string[]` | ✅ | Target event names to route to |

‎content/docs/references/system/IntervalSchedule.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: IntervalSchedule
3+
description: IntervalSchedule Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **type** | `string` | ✅ | |
11+
| **intervalMs** | `integer` | ✅ | Interval in milliseconds |

‎content/docs/references/system/Job.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Job
3+
description: Job Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **id** | `string` | ✅ | Unique job identifier |
11+
| **name** | `string` | ✅ | Job name (snake_case) |
12+
| **schedule** | `object \| object \| object` | ✅ | Job schedule configuration |
13+
| **retryPolicy** | `object` | optional | Retry policy configuration |
14+
| **timeout** | `integer` | optional | Timeout in milliseconds |
15+
| **enabled** | `boolean` | optional | Whether the job is enabled |

‎content/docs/references/system/JobExecution.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: JobExecution
3+
description: JobExecution Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **jobId** | `string` | ✅ | Job identifier |
11+
| **startedAt** | `string` | ✅ | ISO 8601 datetime when execution started |
12+
| **completedAt** | `string` | optional | ISO 8601 datetime when execution completed |
13+
| **status** | `Enum<'running' \| 'success' \| 'failed' \| 'timeout'>` | ✅ | Execution status |
14+
| **error** | `string` | optional | Error message if failed |
15+
| **duration** | `integer` | optional | Execution duration in milliseconds |

‎content/docs/references/system/JobExecutionStatus.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: JobExecutionStatus
3+
description: JobExecutionStatus Schema Reference
4+
---
5+
6+
## Allowed Values
7+
8+
* `running`
9+
* `success`
10+
* `failed`
11+
* `timeout`

0 commit comments

Comments
 (0)