Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/references/auth/role/Role.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Role Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Unique role name |
| **name** | `string` | ✅ | Unique role name (lowercase snake_case) |
| **label** | `string` | ✅ | Display label (e.g. VP of Sales) |
| **parent** | `string` | optional | Parent Role ID (Reports To) |
| **description** | `string` | optional | |
2 changes: 1 addition & 1 deletion content/docs/references/automation/webhook/Webhook.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Webhook Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | |
| **name** | `string` | ✅ | Webhook unique name (lowercase snake_case) |
| **label** | `string` | optional | |
| **object** | `string` | ✅ | Object to listen to |
| **triggers** | `Enum<'create' \| 'update' \| 'delete' \| 'undelete' \| 'api'>[]` | ✅ | Events that trigger execution |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: WebhookReceiver Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | |
| **name** | `string` | ✅ | Webhook receiver unique name (lowercase snake_case) |
| **path** | `string` | ✅ | URL Path (e.g. /webhooks/stripe) |
| **verificationType** | `Enum<'none' \| 'header_token' \| 'hmac' \| 'ip_whitelist'>` | optional | |
| **verificationParams** | `object` | optional | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: WorkflowRule Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Unique workflow name |
| **name** | `string` | ✅ | Unique workflow name (lowercase snake_case) |
| **objectName** | `string` | ✅ | Target Object |
| **triggerType** | `Enum<'on_create' \| 'on_update' \| 'on_create_or_update' \| 'on_delete' \| 'schedule'>` | ✅ | When to evaluate |
| **criteria** | `string` | optional | Formula condition. If TRUE, actions execute. |
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/data/field/SelectOption.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: SelectOption Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **label** | `string` | ✅ | Display label |
| **value** | `string` | ✅ | Stored value |
| **label** | `string` | ✅ | Display label (human-readable, any case allowed) |
| **value** | `string` | ✅ | Stored value (lowercase machine identifier) |
| **color** | `string` | optional | Color code for badges/charts |
| **default** | `boolean` | optional | Is default option |
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: PermissionSet Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Permission set unique name |
| **name** | `string` | ✅ | Permission set unique name (lowercase snake_case) |
| **label** | `string` | optional | Display label |
| **isProfile** | `boolean` | optional | Whether this is a user profile |
| **objects** | `Record<string, object>` | ✅ | Entity permissions |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/permission/territory/Territory.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Territory Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | |
| **name** | `string` | ✅ | Territory unique name (lowercase snake_case) |
| **label** | `string` | ✅ | Territory Label (e.g. "West Coast") |
| **modelId** | `string` | ✅ | Belongs to which Territory Model |
| **parent** | `string` | optional | Parent Territory |
Expand Down
7 changes: 7 additions & 0 deletions content/docs/references/shared/identifiers/EventName.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: EventName
description: Event name (lowercase with dot notation for namespacing)
---

Event name (lowercase with dot notation for namespacing)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SnakeCaseIdentifier
description: Snake case identifier (lowercase with underscores only)
---

Snake case identifier (lowercase with underscores only)

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: SystemIdentifier
description: System identifier (lowercase with underscores or dots)
---

System identifier (lowercase with underscores or dots)

3 changes: 3 additions & 0 deletions content/docs/references/shared/identifiers/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"title": "Identifiers"
}
6 changes: 6 additions & 0 deletions content/docs/references/shared/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"title": "Shared Protocol",
"pages": [
"identifiers"
]
}
2 changes: 1 addition & 1 deletion content/docs/references/system/events/Event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ description: Event Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Event name (snake_case with dots, e.g., user.created) |
| **name** | `string` | ✅ | Event name (lowercase with dots, e.g., user.created, order.paid) |
| **payload** | `any` | optional | Event payload schema |
| **metadata** | `object` | ✅ | Event metadata |
2 changes: 1 addition & 1 deletion content/docs/references/ui/action/Action.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Action Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Machine name (snake_case) |
| **name** | `string` | ✅ | Machine name (lowercase snake_case) |
| **label** | `string` | ✅ | Display label |
| **icon** | `string` | optional | Icon name |
| **locations** | `Enum<'list_toolbar' \| 'list_item' \| 'record_header' \| 'record_more' \| 'record_related' \| 'global_nav'>[]` | optional | Locations where this action is visible |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/ui/app/App.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: App Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | App unique machine name |
| **name** | `string` | ✅ | App unique machine name (lowercase snake_case) |
| **label** | `string` | ✅ | App display label |
| **version** | `string` | optional | App version |
| **description** | `string` | optional | App description |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/ui/app/DashboardNavItem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: DashboardNavItem Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Unique identifier for this navigation item |
| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) |
| **label** | `string` | ✅ | Display proper label |
| **icon** | `string` | optional | Icon name |
| **visible** | `string` | optional | Visibility formula condition |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/ui/app/GroupNavItem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: GroupNavItem Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Unique identifier for this navigation item |
| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) |
| **label** | `string` | ✅ | Display proper label |
| **icon** | `string` | optional | Icon name |
| **visible** | `string` | optional | Visibility formula condition |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/ui/app/ObjectNavItem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: ObjectNavItem Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Unique identifier for this navigation item |
| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) |
| **label** | `string` | ✅ | Display proper label |
| **icon** | `string` | optional | Icon name |
| **visible** | `string` | optional | Visibility formula condition |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/ui/app/PageNavItem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: PageNavItem Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Unique identifier for this navigation item |
| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) |
| **label** | `string` | ✅ | Display proper label |
| **icon** | `string` | optional | Icon name |
| **visible** | `string` | optional | Visibility formula condition |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/ui/app/UrlNavItem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: UrlNavItem Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Unique identifier for this navigation item |
| **id** | `string` | ✅ | Unique identifier for this navigation item (lowercase snake_case) |
| **label** | `string` | ✅ | Display proper label |
| **icon** | `string` | optional | Icon name |
| **visible** | `string` | optional | Visibility formula condition |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/ui/page/Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Page Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | |
| **name** | `string` | ✅ | Page unique name (lowercase snake_case) |
| **label** | `string` | ✅ | |
| **description** | `string` | optional | |
| **type** | `Enum<'record' \| 'home' \| 'app' \| 'utility'>` | optional | |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/ui/view/ListView.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: ListView Schema Reference

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | optional | |
| **name** | `string` | optional | Internal view name (lowercase snake_case) |
| **label** | `string` | optional | |
| **type** | `Enum<'grid' \| 'kanban' \| 'calendar' \| 'gantt' \| 'map'>` | optional | |
| **data** | `object \| object \| object` | optional | Data source configuration (defaults to "object" provider) |
Expand Down
5 changes: 3 additions & 2 deletions packages/spec/json-schema/auth/Role.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z_][a-z0-9_]*$",
"description": "Unique role name"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Unique role name (lowercase snake_case)"
},
"label": {
"type": "string",
Expand Down
4 changes: 3 additions & 1 deletion packages/spec/json-schema/automation/Webhook.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z_][a-z0-9_]*$"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Webhook unique name (lowercase snake_case)"
},
"label": {
"type": "string"
Expand Down
4 changes: 3 additions & 1 deletion packages/spec/json-schema/automation/WebhookReceiver.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z_][a-z0-9_]*$"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Webhook receiver unique name (lowercase snake_case)"
},
"path": {
"type": "string",
Expand Down
5 changes: 3 additions & 2 deletions packages/spec/json-schema/automation/WorkflowRule.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z_][a-z0-9_]*$",
"description": "Unique workflow name"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Unique workflow name (lowercase snake_case)"
},
"objectName": {
"type": "string",
Expand Down
6 changes: 4 additions & 2 deletions packages/spec/json-schema/data/Field.json
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,13 @@
"properties": {
"label": {
"type": "string",
"description": "Display label"
"description": "Display label (human-readable, any case allowed)"
},
"value": {
"type": "string",
"description": "Stored value"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_.]*$",
"description": "Stored value (lowercase machine identifier)"
},
"color": {
"type": "string",
Expand Down
6 changes: 4 additions & 2 deletions packages/spec/json-schema/data/Object.json
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,13 @@
"properties": {
"label": {
"type": "string",
"description": "Display label"
"description": "Display label (human-readable, any case allowed)"
},
"value": {
"type": "string",
"description": "Stored value"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_.]*$",
"description": "Stored value (lowercase machine identifier)"
},
"color": {
"type": "string",
Expand Down
6 changes: 4 additions & 2 deletions packages/spec/json-schema/data/SelectOption.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@
"properties": {
"label": {
"type": "string",
"description": "Display label"
"description": "Display label (human-readable, any case allowed)"
},
"value": {
"type": "string",
"description": "Stored value"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_.]*$",
"description": "Stored value (lowercase machine identifier)"
},
"color": {
"type": "string",
Expand Down
6 changes: 4 additions & 2 deletions packages/spec/json-schema/hub/ComposerResponse.json
Original file line number Diff line number Diff line change
Expand Up @@ -227,11 +227,13 @@
"properties": {
"label": {
"type": "string",
"description": "Display label"
"description": "Display label (human-readable, any case allowed)"
},
"value": {
"type": "string",
"description": "Stored value"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_.]*$",
"description": "Stored value (lowercase machine identifier)"
},
"color": {
"type": "string",
Expand Down
6 changes: 4 additions & 2 deletions packages/spec/json-schema/kernel/Manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -221,11 +221,13 @@
"properties": {
"label": {
"type": "string",
"description": "Display label"
"description": "Display label (human-readable, any case allowed)"
},
"value": {
"type": "string",
"description": "Stored value"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_.]*$",
"description": "Stored value (lowercase machine identifier)"
},
"color": {
"type": "string",
Expand Down
4 changes: 3 additions & 1 deletion packages/spec/json-schema/permission/PermissionSet.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
"properties": {
"name": {
"type": "string",
"description": "Permission set unique name"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Permission set unique name (lowercase snake_case)"
},
"label": {
"type": "string",
Expand Down
4 changes: 3 additions & 1 deletion packages/spec/json-schema/permission/Territory.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z_][a-z0-9_]*$"
"minLength": 2,
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Territory unique name (lowercase snake_case)"
},
"label": {
"type": "string",
Expand Down
12 changes: 12 additions & 0 deletions packages/spec/json-schema/shared/EventName.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"$ref": "#/definitions/EventName",
"definitions": {
"EventName": {
"type": "string",
"minLength": 3,
"pattern": "^[a-z][a-z0-9_.]*$",
"description": "Event name (lowercase with dot notation for namespacing)"
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
12 changes: 12 additions & 0 deletions packages/spec/json-schema/shared/SnakeCaseIdentifier.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"$ref": "#/definitions/SnakeCaseIdentifier",
"definitions": {
"SnakeCaseIdentifier": {
"type": "string",
"minLength": 2,
"pattern": "^[a-z][a-z0-9_]*$",
"description": "Snake case identifier (lowercase with underscores only)"
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
12 changes: 12 additions & 0 deletions packages/spec/json-schema/shared/SystemIdentifier.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"$ref": "#/definitions/SystemIdentifier",
"definitions": {
"SystemIdentifier": {
"type": "string",
"minLength": 2,
"pattern": "^[a-z][a-z0-9_.]*$",
"description": "System identifier (lowercase with underscores or dots)"
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
5 changes: 3 additions & 2 deletions packages/spec/json-schema/system/Event.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z_][a-z0-9_.]*$",
"description": "Event name (snake_case with dots, e.g., user.created)"
"minLength": 3,
"pattern": "^[a-z][a-z0-9_.]*$",
"description": "Event name (lowercase with dots, e.g., user.created, order.paid)"
},
"payload": {
"description": "Event payload schema"
Expand Down
Loading
Loading