Skip to content

Commit 6f8a84a

Browse files
committed
Add schema reference documentation for various components
- Created documentation for NetworkPolicy, OIDCConfig, OWDModel, Object, ObjectCapabilities, ObjectNavItem, ObjectPermission, Page, PageComponent, PageNavItem, PageRegion, PasswordPolicy, PermissionSet, Plan, Policy, Query, RateLimit, Report, ReportChart, ReportColumn, ReportGrouping, ReportType, Role, SAMLConfig, ScriptValidation, SelectOption, SessionPolicy, SharingLevel, SharingRule, SharingRuleType, SortNode, StateMachineValidation, Territory, TerritoryModel, TerritoryType, TransformType, TranslationBundle, TranslationData, UniquenessValidation, UrlNavItem, ValidationRule, View, Webhook, WebhookReceiver, WebhookTriggerType, WorkflowAction, WorkflowRule, and WorkflowTriggerType. - Implemented a script to automate the generation of markdown documentation from JSON schema files.
1 parent 1dcdd87 commit 6f8a84a

File tree

109 files changed

+1800
-4
lines changed

Some content is hidden

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

109 files changed

+1800
-4
lines changed

.github/copilot-instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
**Context:** You are defining the "DNA" and "Constitution" of a metadata-driven low-code platform.
55
**Location:** `packages/spec` repository.
66

7+
Mission: Build the "Post-SaaS Operating System" — an open-core, local-first ecosystem that virtualizes data (SQL/Redis/Excel) and unifies business logic.
8+
79
**PRIME DIRECTIVES:**
810

911
1. **Zod First:** ALL definitions must start with a **Zod Schema**. We need runtime validation for the CLI and JSON Schema generation for the IDE.

.github/prompts/schema.prompt.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
**Location:** `packages/spec` repository.
66

77
Mission: Build the "Post-SaaS Operating System" — an open-core, local-first ecosystem that virtualizes data (SQL/Redis/Excel) and unifies business logic.
8-
1. The "Galaxy" Architecture (Monorepo Structure)
9-
We use a Monorepo (pnpm + Turborepo) to manage the ecosystem, but components are designed to be published independently.
108
Project & Responsibilities
119
* packages/protocol (The Constitution) [Apache 2.0]
1210
* CRITICAL: Contains the shared manifest.schema.json, TypeScript interfaces, and plugin lifecycle hooks (onInstall, onEnable).
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: AIKnowledge
3+
description: AIKnowledge Schema Reference
4+
---
5+
6+
# AIKnowledge
7+
8+
## Properties
9+
10+
| Property | Type | Required | Description |
11+
| :--- | :--- | :--- | :--- |
12+
| **topics** | `string[]` || Topics/Tags to recruit knowledge from |
13+
| **indexes** | `string[]` || Vector Store Indexes |
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: AIModelConfig
3+
description: AIModelConfig Schema Reference
4+
---
5+
6+
# AIModelConfig
7+
8+
## Properties
9+
10+
| Property | Type | Required | Description |
11+
| :--- | :--- | :--- | :--- |
12+
| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'local'>` | optional | |
13+
| **model** | `string` || Model name (e.g. gpt-4, claude-3-opus) |
14+
| **temperature** | `number` | optional | |
15+
| **maxTokens** | `number` | optional | |
16+
| **topP** | `number` | optional | |

content/docs/references/AITool.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: AITool
3+
description: AITool Schema Reference
4+
---
5+
6+
# AITool
7+
8+
## Properties
9+
10+
| Property | Type | Required | Description |
11+
| :--- | :--- | :--- | :--- |
12+
| **type** | `Enum<'action' \| 'flow' \| 'query' \| 'vector_search'>` || |
13+
| **name** | `string` || Reference name (Action Name, Flow Name) |
14+
| **description** | `string` | optional | Override description for the LLM |

content/docs/references/Action.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Action
3+
description: Action Schema Reference
4+
---
5+
6+
# Action
7+
8+
## Properties
9+
10+
| Property | Type | Required | Description |
11+
| :--- | :--- | :--- | :--- |
12+
| **name** | `string` || Machine name (snake_case) |
13+
| **label** | `string` || Display label |
14+
| **icon** | `string` | optional | Icon name |
15+
| **locations** | `Enum<'list_toolbar' \| 'list_item' \| 'record_header' \| 'record_more' \| 'record_related' \| 'global_nav'>[]` | optional | Locations where this action is visible |
16+
| **location** | `any` | optional | |
17+
| **type** | `Enum<'script' \| 'url' \| 'modal' \| 'flow' \| 'api'>` | optional | Action functionality type |
18+
| **target** | `string` | optional | URL, Script Name, Flow ID, or API Endpoint |
19+
| **execute** | `string` | optional | Legacy execution logic |
20+
| **params** | `object[]` | optional | Input parameters required from user |
21+
| **confirmText** | `string` | optional | Confirmation message before execution |
22+
| **successMessage** | `string` | optional | Success message to show after execution |
23+
| **refreshAfter** | `boolean` | optional | Refresh view after execution |
24+
| **visible** | `string` | optional | Formula returning boolean |
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: ActionParam
3+
description: ActionParam Schema Reference
4+
---
5+
6+
# ActionParam
7+
8+
## Properties
9+
10+
| Property | Type | Required | Description |
11+
| :--- | :--- | :--- | :--- |
12+
| **name** | `string` || |
13+
| **label** | `string` || |
14+
| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'markdown' \| 'html' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'select' \| 'multiselect' \| 'lookup' \| 'master_detail' \| 'image' \| 'file' \| 'avatar' \| 'formula' \| 'summary' \| 'autonumber'>` || |
15+
| **required** | `boolean` | optional | |
16+
| **options** | `object[]` | optional | |

content/docs/references/Agent.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Agent
3+
description: Agent Schema Reference
4+
---
5+
6+
# Agent
7+
8+
## Properties
9+
10+
| Property | Type | Required | Description |
11+
| :--- | :--- | :--- | :--- |
12+
| **name** | `string` || Agent unique identifier |
13+
| **label** | `string` || Agent display name |
14+
| **avatar** | `string` | optional | |
15+
| **role** | `string` || The persona/role (e.g. "Senior Support Engineer") |
16+
| **instructions** | `string` || System Prompt / Prime Directives |
17+
| **model** | `object` | optional | |
18+
| **tools** | `object[]` | optional | Available tools |
19+
| **knowledge** | `object` | optional | RAG access |
20+
| **active** | `boolean` | optional | |
21+
| **access** | `string[]` | optional | Who can chat with this agent |
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: ApiEndpoint
3+
description: ApiEndpoint Schema Reference
4+
---
5+
6+
# ApiEndpoint
7+
8+
## Properties
9+
10+
| Property | Type | Required | Description |
11+
| :--- | :--- | :--- | :--- |
12+
| **name** | `string` || Unique endpoint ID |
13+
| **path** | `string` || URL Path (e.g. /api/v1/customers) |
14+
| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'DELETE' \| 'PATCH'>` || HTTP Method |
15+
| **summary** | `string` | optional | |
16+
| **description** | `string` | optional | |
17+
| **type** | `Enum<'flow' \| 'script' \| 'object_operation' \| 'proxy'>` || Implementation type |
18+
| **target** | `string` || Target Flow ID, Script Name, or Proxy URL |
19+
| **objectParams** | `object` | optional | For object_operation type |
20+
| **inputMapping** | `object[]` | optional | Map Request Body to Internal Params |
21+
| **outputMapping** | `object[]` | optional | Map Internal Result to Response Body |
22+
| **authRequired** | `boolean` | optional | Require authentication |
23+
| **rateLimit** | `object` | optional | Rate limiting policy |
24+
| **cacheTtl** | `number` | optional | Response cache TTL in seconds |
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: ApiMapping
3+
description: ApiMapping Schema Reference
4+
---
5+
6+
# ApiMapping
7+
8+
## Properties
9+
10+
| Property | Type | Required | Description |
11+
| :--- | :--- | :--- | :--- |
12+
| **source** | `string` || Source field/path |
13+
| **target** | `string` || Target field/path |
14+
| **transform** | `string` | optional | Transformation function name |

0 commit comments

Comments
 (0)