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
4 changes: 4 additions & 0 deletions .changeset/regenerate-references.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

docs: regenerate `content/docs/references/**` from current `packages/spec` schemas. Picks up spec additions that had drifted out of the committed generated docs — new `UserFilters`/`UserFilterField` view types, the `chart` visualization enum value, the ADR-0046 `doc`/`book` package-doc protocols, and the `contracts/` reference group. Generated output only; no package version impact.
15 changes: 6 additions & 9 deletions content/docs/references/ai/meta.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
{
"title": "AI Protocol",
"pages": [
"---Agents & Tools---",
"agent",
"tool",
"skill",
"conversation",
"mcp",
"---Knowledge & Embeddings---",
"knowledge-source",
"knowledge-document",
"embedding",
"---Models & Solutions---",
"knowledge-document",
"knowledge-source",
"mcp",
"model-registry",
"skill",
"solution-blueprint",
"tool",
"usage"
]
}
}
61 changes: 27 additions & 34 deletions content/docs/references/api/meta.json
Original file line number Diff line number Diff line change
@@ -1,50 +1,43 @@
{
"title": "API Protocol",
"pages": [
"---Overview---",
"protocol",
"analytics",
"auth",
"auth-endpoints",
"automation-api",
"batch",
"connector",
"contract",
"core-services",
"documentation",
"discovery",
"---REST & HTTP---",
"rest-server",
"router",
"dispatcher",
"documentation",
"endpoint",
"object",
"batch",
"errors",
"events",
"export",
"feed-api",
"graphql",
"http",
"http-cache",
"errors",
"versioning",
"---Query Interfaces---",
"query-adapter",
"graphql",
"odata",
"analytics",
"identity",
"metadata",
"metadata-plugin",
"contract",
"---Auth & Identity---",
"auth",
"auth-endpoints",
"identity",
"---Realtime & Events---",
"realtime",
"realtime-shared",
"websocket",
"events",
"dispatcher",
"notification",
"feed-api",
"---Automation & Integration---",
"automation-api",
"connector",
"plugin-rest-api",
"---Packages & Storage---",
"object",
"odata",
"package-api",
"package-registry",
"plugin-rest-api",
"protocol",
"query-adapter",
"realtime",
"realtime-shared",
"registry",
"storage"
"rest-server",
"router",
"storage",
"versioning",
"websocket"
]
}
}
4 changes: 2 additions & 2 deletions content/docs/references/api/metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ Metadata query with filtering, sorting, and pagination

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **types** | `Enum<'object' \| 'field' \| 'trigger' \| 'validation' \| 'hook' \| 'seed' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'router' \| 'function' \| 'service' \| 'email_template' \| 'permission' \| 'profile' \| 'role' \| 'agent' \| 'tool' \| 'skill'>[]` | optional | Filter by metadata types |
| **types** | `Enum<'object' \| 'field' \| 'trigger' \| 'validation' \| 'hook' \| 'seed' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'router' \| 'function' \| 'service' \| 'email_template' \| 'doc' \| 'book' \| 'permission' \| 'profile' \| 'role' \| 'agent' \| 'tool' \| 'skill'>[]` | optional | Filter by metadata types |
| **namespaces** | `string[]` | optional | Filter by namespaces |
| **packageId** | `string` | optional | Filter by owning package |
| **search** | `string` | optional | Full-text search query |
Expand Down Expand Up @@ -349,7 +349,7 @@ Metadata query with filtering, sorting, and pagination

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **type** | `Enum<'object' \| 'field' \| 'trigger' \| 'validation' \| 'hook' \| 'seed' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'router' \| 'function' \| 'service' \| 'email_template' \| 'permission' \| 'profile' \| 'role' \| 'agent' \| 'tool' \| 'skill'>` | ✅ | Metadata type |
| **type** | `Enum<'object' \| 'field' \| 'trigger' \| 'validation' \| 'hook' \| 'seed' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'router' \| 'function' \| 'service' \| 'email_template' \| 'doc' \| 'book' \| 'permission' \| 'profile' \| 'role' \| 'agent' \| 'tool' \| 'skill'>` | ✅ | Metadata type |
| **name** | `string` | ✅ | Item name (snake_case) |
| **data** | `Record<string, any>` | ✅ | Metadata payload |
| **namespace** | `string` | optional | Optional namespace |
Expand Down
1 change: 1 addition & 0 deletions content/docs/references/automation/approval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ const result = ApprovalDecision.parse(data);
| **lockRecord** | `boolean` | ✅ | Lock the record from editing while pending |
| **approvalStatusField** | `string` | optional | Business-object field to mirror request status onto |
| **escalation** | `Object` | optional | Per-node SLA escalation |
| **maxRevisions** | `integer` | ✅ | Max send-backs for revision before auto-reject (0 = send-back disabled) |


---
Expand Down
23 changes: 10 additions & 13 deletions content/docs/references/automation/meta.json
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
{
"title": "Automation Protocol",
"pages": [
"---Flows & Execution---",
"flow",
"execution",
"node-executor",
"state-machine",
"approval",
"bpmn-interop",
"---Triggers & Jobs---",
"trigger-registry",
"connector",
"etl",
"execution",
"flow",
"job",
"webhook",
"node-executor",
"offline",
"---Workflows & Integration---",
"approval",
"etl",
"state-machine",
"sync",
"connector"
"trigger-registry",
"webhook"
]
}
}
1 change: 1 addition & 0 deletions content/docs/references/automation/node-executor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ Canonical cross-paradigm action/node descriptor (ADR-0018)
| **supportsRetry** | `boolean` | ✅ | Supports retry on failure |
| **needsOutbox** | `boolean` | ✅ | Dispatch via service-messaging outbox (retry/idempotency/dead-letter) |
| **isAsync** | `boolean` | ✅ | Suspends the flow awaiting an external reply |
| **maturity** | `Enum<'ga' \| 'beta' \| 'reserved'>` | ✅ | Runtime maturity: ga (shipped), beta, or reserved (contract only — designers grey this out) |
| **source** | `Enum<'builtin' \| 'plugin'>` | ✅ | builtin = platform baseline; plugin = third-party contributed |
| **deprecated** | `boolean` | ✅ | Deprecated alias kept for back-compat |
| **aliasOf** | `string` | optional | Canonical type this alias forwards to |
Expand Down
15 changes: 6 additions & 9 deletions content/docs/references/cloud/meta.json
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
{
"title": "Cloud Protocol",
"pages": [
"---Environments---",
"app-store",
"developer-portal",
"environment",
"environment-artifact",
"environment-package",
"provisioning",
"tenant",
"---Marketplace & Distribution---",
"marketplace",
"marketplace-admin",
"app-store",
"developer-portal",
"---Packages---",
"package",
"package-version",
"plugin-security",
"provisioning",
"template-manifest",
"plugin-security"
"tenant"
]
}
}
4 changes: 4 additions & 0 deletions content/docs/references/contracts/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Contracts Protocol",
"pages": []
}
36 changes: 15 additions & 21 deletions content/docs/references/data/meta.json
Original file line number Diff line number Diff line change
@@ -1,35 +1,29 @@
{
"title": "Data Protocol",
"pages": [
"---Core Modeling---",
"object",
"field",
"validation",
"mapping",
"document",
"---Query & Filter---",
"query",
"filter",
"date-macros",
"analytics",
"---Engine & Drivers---",
"data-engine",
"datasource",
"date-macros",
"document",
"driver",
"driver-sql",
"driver-nosql",
"---Hooks & Lifecycle---",
"driver-sql",
"external-catalog",
"external-lookup",
"feed",
"field",
"filter",
"hook",
"hook-body",
"subscription",
"feed",
"mapping",
"notification",
"---External Data---",
"external-catalog",
"external-lookup",
"object",
"query",
"search-engine",
"---Seeding---",
"seed",
"seed-loader"
"seed-loader",
"subscription",
"validation"
]
}
}
49 changes: 22 additions & 27 deletions content/docs/references/kernel/meta.json
Original file line number Diff line number Diff line change
@@ -1,42 +1,37 @@
{
"title": "Kernel Protocol",
"pages": [
"---Core Runtime---",
"cli-extension",
"cluster",
"context",
"dependency-resolution",
"dev-plugin",
"execution-context",
"manifest",
"feature",
"service-registry",
"startup-orchestrator",
"cluster",
"state-machine",
"cli-extension",
"dev-plugin",
"manifest",
"metadata-customization",
"metadata-loader",
"metadata-persistence",
"metadata-plugin",
"metadata-protection",
"misc",
"---Plugin Lifecycle---",
"package-artifact",
"package-registry",
"package-upgrade",
"plugin",
"plugin-structure",
"plugin-loading",
"plugin-lifecycle-events",
"plugin-capability",
"plugin-lifecycle-advanced",
"plugin-runtime",
"plugin-lifecycle-events",
"plugin-loading",
"plugin-registry",
"plugin-capability",
"---Plugin Security & Validation---",
"plugin-runtime",
"plugin-security",
"plugin-security-advanced",
"plugin-structure",
"plugin-validator",
"plugin-versioning",
"---Dependencies & Packages---",
"dependency-resolution",
"package-artifact",
"package-registry",
"package-upgrade",
"---Metadata---",
"metadata-loader",
"metadata-persistence",
"metadata-plugin",
"metadata-customization",
"metadata-protection"
"service-registry",
"startup-orchestrator",
"state-machine"
]
}
}
6 changes: 4 additions & 2 deletions content/docs/references/kernel/metadata-plugin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ const result = MetadataBulkRegisterRequest.parse(data);
| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **event** | `Enum<'metadata.registered' \| 'metadata.updated' \| 'metadata.unregistered' \| 'metadata.validated' \| 'metadata.deployed' \| 'metadata.overlay.applied' \| 'metadata.overlay.removed' \| 'metadata.imported' \| 'metadata.exported'>` | ✅ | Event type |
| **metadataType** | `Enum<'object' \| 'field' \| 'trigger' \| 'validation' \| 'hook' \| 'seed' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'router' \| 'function' \| 'service' \| 'email_template' \| 'permission' \| 'profile' \| 'role' \| 'agent' \| 'tool' \| 'skill'>` | ✅ | Metadata type |
| **metadataType** | `Enum<'object' \| 'field' \| 'trigger' \| 'validation' \| 'hook' \| 'seed' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'router' \| 'function' \| 'service' \| 'email_template' \| 'doc' \| 'book' \| 'permission' \| 'profile' \| 'role' \| 'agent' \| 'tool' \| 'skill'>` | ✅ | Metadata type |
| **name** | `string` | ✅ | Metadata item name |
| **namespace** | `string` | optional | Namespace |
| **packageId** | `string` | optional | Owning package ID |
Expand All @@ -147,7 +147,7 @@ const result = MetadataBulkRegisterRequest.parse(data);

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **types** | `Enum<'object' \| 'field' \| 'trigger' \| 'validation' \| 'hook' \| 'seed' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'router' \| 'function' \| 'service' \| 'email_template' \| 'permission' \| 'profile' \| 'role' \| 'agent' \| 'tool' \| 'skill'>[]` | optional | Filter by metadata types |
| **types** | `Enum<'object' \| 'field' \| 'trigger' \| 'validation' \| 'hook' \| 'seed' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'router' \| 'function' \| 'service' \| 'email_template' \| 'doc' \| 'book' \| 'permission' \| 'profile' \| 'role' \| 'agent' \| 'tool' \| 'skill'>[]` | optional | Filter by metadata types |
| **namespaces** | `string[]` | optional | Filter by namespaces |
| **packageId** | `string` | optional | Filter by owning package |
| **search** | `string` | optional | Full-text search query |
Expand Down Expand Up @@ -202,6 +202,8 @@ const result = MetadataBulkRegisterRequest.parse(data);
* `function`
* `service`
* `email_template`
* `doc`
* `book`
* `permission`
* `profile`
* `role`
Expand Down
6 changes: 3 additions & 3 deletions content/docs/references/security/permission.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ const result = FieldPermission.parse(data);
| **allowRead** | `boolean` | ✅ | Read permission |
| **allowEdit** | `boolean` | ✅ | Edit permission |
| **allowDelete** | `boolean` | ✅ | Delete permission |
| **allowTransfer** | `boolean` | ✅ | Change record ownership |
| **allowRestore** | `boolean` | ✅ | Restore from trash (Undelete) |
| **allowPurge** | `boolean` | ✅ | Permanently delete (Hard Delete/GDPR) |
| **allowTransfer** | `boolean` | ✅ | [EXPERIMENTAL — not enforced] Change record ownership |
| **allowRestore** | `boolean` | ✅ | [EXPERIMENTAL — not enforced] Restore from trash (Undelete) |
| **allowPurge** | `boolean` | ✅ | [EXPERIMENTAL — not enforced] Permanently delete (Hard Delete/GDPR) |
| **viewAllRecords** | `boolean` | ✅ | View All Data (Bypass Sharing) |
| **modifyAllRecords** | `boolean` | ✅ | Modify All Data (Bypass Sharing) |

Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/security/policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ const result = AuditPolicy.parse(data);

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Policy Name |
| **name** | `string` | ✅ | [EXPERIMENTAL — not enforced] Policy Name |
| **password** | `Object` | optional | |
| **network** | `Object` | optional | |
| **session** | `Object` | optional | |
Expand Down
Loading