Skip to content

Commit 2d2cc86

Browse files
committed
2 parents 643a2ba + 6170ec6 commit 2d2cc86

Some content is hidden

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

70 files changed

+802
-96
lines changed

content/docs/references/auth/role/Role.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Role Schema Reference
77

88
| Property | Type | Required | Description |
99
| :--- | :--- | :--- | :--- |
10-
| **name** | `string` || Unique role name |
10+
| **name** | `string` || Unique role name (lowercase snake_case) |
1111
| **label** | `string` || Display label (e.g. VP of Sales) |
1212
| **parent** | `string` | optional | Parent Role ID (Reports To) |
1313
| **description** | `string` | optional | |

content/docs/references/automation/webhook/Webhook.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Webhook Schema Reference
77

88
| Property | Type | Required | Description |
99
| :--- | :--- | :--- | :--- |
10-
| **name** | `string` || |
10+
| **name** | `string` || Webhook unique name (lowercase snake_case) |
1111
| **label** | `string` | optional | |
1212
| **object** | `string` || Object to listen to |
1313
| **triggers** | `Enum<'create' \| 'update' \| 'delete' \| 'undelete' \| 'api'>[]` || Events that trigger execution |

content/docs/references/automation/webhook/WebhookReceiver.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: WebhookReceiver Schema Reference
77

88
| Property | Type | Required | Description |
99
| :--- | :--- | :--- | :--- |
10-
| **name** | `string` || |
10+
| **name** | `string` || Webhook receiver unique name (lowercase snake_case) |
1111
| **path** | `string` || URL Path (e.g. /webhooks/stripe) |
1212
| **verificationType** | `Enum<'none' \| 'header_token' \| 'hmac' \| 'ip_whitelist'>` | optional | |
1313
| **verificationParams** | `object` | optional | |

content/docs/references/automation/workflow/WorkflowRule.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: WorkflowRule Schema Reference
77

88
| Property | Type | Required | Description |
99
| :--- | :--- | :--- | :--- |
10-
| **name** | `string` || Unique workflow name |
10+
| **name** | `string` || Unique workflow name (lowercase snake_case) |
1111
| **objectName** | `string` || Target Object |
1212
| **triggerType** | `Enum<'on_create' \| 'on_update' \| 'on_create_or_update' \| 'on_delete' \| 'schedule'>` || When to evaluate |
1313
| **criteria** | `string` | optional | Formula condition. If TRUE, actions execute. |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: SelectOption Schema Reference
77

88
| Property | Type | Required | Description |
99
| :--- | :--- | :--- | :--- |
10-
| **label** | `string` || Display label |
11-
| **value** | `string` || Stored value |
10+
| **label** | `string` || Display label (human-readable, any case allowed) |
11+
| **value** | `string` || Stored value (lowercase machine identifier) |
1212
| **color** | `string` | optional | Color code for badges/charts |
1313
| **default** | `boolean` | optional | Is default option |

content/docs/references/permission/permission/PermissionSet.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: PermissionSet Schema Reference
77

88
| Property | Type | Required | Description |
99
| :--- | :--- | :--- | :--- |
10-
| **name** | `string` || Permission set unique name |
10+
| **name** | `string` || Permission set unique name (lowercase snake_case) |
1111
| **label** | `string` | optional | Display label |
1212
| **isProfile** | `boolean` | optional | Whether this is a user profile |
1313
| **objects** | `Record<string, object>` || Entity permissions |

content/docs/references/permission/territory/Territory.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Territory Schema Reference
77

88
| Property | Type | Required | Description |
99
| :--- | :--- | :--- | :--- |
10-
| **name** | `string` || |
10+
| **name** | `string` || Territory unique name (lowercase snake_case) |
1111
| **label** | `string` || Territory Label (e.g. "West Coast") |
1212
| **modelId** | `string` || Belongs to which Territory Model |
1313
| **parent** | `string` | optional | Parent Territory |
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: EventName
3+
description: Event name (lowercase with dot notation for namespacing)
4+
---
5+
6+
Event name (lowercase with dot notation for namespacing)
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: SnakeCaseIdentifier
3+
description: Snake case identifier (lowercase with underscores only)
4+
---
5+
6+
Snake case identifier (lowercase with underscores only)
7+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: SystemIdentifier
3+
description: System identifier (lowercase with underscores or dots)
4+
---
5+
6+
System identifier (lowercase with underscores or dots)
7+

0 commit comments

Comments
 (0)