You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(spec): regenerate reference docs after dead-prop removal (#2377)
Regenerated content/docs/references/ from the updated spec schema
(pnpm gen:schema && gen:docs) — field/object/action/agent/dataset
reference pages drop the removed properties; data/search-engine.mdx
and api/object.mdx removed as spec no longer defines them.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011XchBKhKdjbhQZymt9Gn9B
|**tenantId**|`string`| optional | Tenant/Organization ID |
87
87
|**visibility**|`Enum<'global' \| 'organization' \| 'private'>`| ✅ |[EXPERIMENTAL — NOT ENFORCED, #1901] Intended listing scope. No runtime consumer yet; use access/permissions for real gating. |
|**vectorConfig**|`{ dimensions: integer; distanceMetric?: Enum<'cosine' \| 'euclidean' \| 'dotProduct' \| 'manhattan'>; normalized?: boolean; indexed?: boolean; … }`| optional | Configuration for vector field type (AI/ML embeddings) |
143
-
|**fileAttachmentConfig**|`{ minSize?: number; maxSize?: number; allowedTypes?: string[]; blockedTypes?: string[]; … }`| optional | Configuration for file and attachment field types |
144
142
|**trackHistory**|`boolean`| optional | Render this field's value changes as human-readable entries on the record activity timeline (ADR-0052 §5b). Opt-in per field. |
145
-
|**dependencies**|`string[]`| optional | Array of field names that this field depends on (for formulas, visibility rules, etc.) |
146
143
|**group**|`string`| optional | Field group name for organizing fields in forms and layouts (e.g., "contact_info", "billing", "system") |
147
144
|**visibleWhen**|`string \| { dialect: Enum<'cel' \| 'js' \| 'cron' \| 'template'>; source?: string; ast?: any; meta?: object }`| optional | Predicate (CEL) — field is shown only when TRUE (else hidden). e.g. P`record.type == 'invoice'`|
148
145
|**readonlyWhen**|`string \| { dialect: Enum<'cel' \| 'js' \| 'cron' \| 'template'>; source?: string; ast?: any; meta?: object }`| optional | Predicate (CEL) — field is read-only when TRUE. e.g. P`record.status == 'paid'`|
@@ -217,40 +214,6 @@ const result = Address.parse(data);
217
214
*`vector`
218
215
219
216
220
-
---
221
-
222
-
## FileAttachmentConfig
223
-
224
-
### Properties
225
-
226
-
| Property | Type | Required | Description |
227
-
| :--- | :--- | :--- | :--- |
228
-
|**minSize**|`number`| optional | Minimum file size in bytes |
229
-
|**maxSize**|`number`| optional | Maximum file size in bytes (e.g., 10485760 = 10MB) |
|**activityMilestones**|`{ field: string; value: string; summary: string; type?: string }[]`| optional | Declarative semantic activity milestones — emit a templated timeline row when a field transitions into a value, no hook code (ADR-0052 §5b.2). |
123
-
|**nameField**|`string`| optional |[ADR-0079] Canonical primary title field — the stored field used as the record display name (e.g. "name", "title"). Pairs with recordName. |
121
+
|**nameField**|`string`| optional |[ADR-0079] Canonical primary title field — the stored field used as the record display name (e.g. "name", "title"). |
124
122
|**displayNameField**|`string`| optional |[DEPRECATED → nameField] Field to use as the record display name (e.g., "name", "title"). Accepted as an alias for nameField. |
125
-
|**recordName**|`{ type: Enum<'text' \| 'autonumber'>; displayFormat?: string; startNumber?: integer }`| optional | Record name generation configuration (Salesforce pattern) |
126
123
|**titleFormat**|`string \| { dialect: Enum<'cel' \| 'js' \| 'cron' \| 'template'>; source?: string; ast?: any; meta?: object }`| optional |[DEPRECATED → nameField (ADR-0079)] Render-only title template; the server cannot return or query it, and an explicit nameField now takes precedence. Migrate a single-field title to nameField, a composite to a formula field designated as nameField. |
127
124
|**highlightFields**|`string[]`| optional |[ADR-0085] Ordered most-important fields; first entry wins where only one fits. Drives default columns, cards, previews, detail highlight strip. Renamed from compactLayout. |
128
125
|**stageField**|`string \| 'false'`| optional |[ADR-0085] Lifecycle stage field (linear/ordered), or false to declare the status field non-linear and suppress stage heuristics. Absent = heuristic detection allowed. |
|**searchableFields**|`string[]`| optional | Fields the `$search` query matches against (ADR-0061). Canonical default for the record picker, list quick-search and global search; views may narrow it. When unset, search auto-defaults to the name/title field plus short-text fields. |
|**sharingModel**|`Enum<'private' \| 'public_read' \| 'public_read_write' \| 'controlled_by_parent'>`| optional | Org-Wide Default record visibility (OWD) for INTERNAL users. Canonical four only (legacy aliases removed, ADR-0090 D4): private (owner-only) \| public_read (everyone reads, owner writes) \| public_read_write (everyone reads+writes) \| controlled_by_parent (derived from the master record). A CUSTOM object that omits this resolves to private at runtime (ADR-0090 D1). |
134
130
|**externalSharingModel**|`Enum<'private' \| 'public_read' \| 'public_read_write' \| 'controlled_by_parent'>`| optional |[ADR-0090 D11] OWD for external (portal/partner) principals. Defaults to private; must be <= sharingModel in openness. |
0 commit comments