Skip to content

Commit 3642509

Browse files
os-zhuangclaude
andauthored
docs: regenerate references from current spec (#1908)
The committed content/docs/references/** had drifted from packages/spec — running `gen:docs` produced diffs across 18 generated files and 3 missing ones (contracts/, system/book.mdx, system/doc.mdx for newly-added spec types). This regenerates them so the generated reference docs match the schemas again. Spec additions now reflected: UserFilters/UserFilterField view config, the `chart` visualization enum value, the ADR-0046 doc/book package-doc protocols, and the contracts reference group. Generated output only (DO-NOT-EDIT files) — no hand-written docs or package code touched. `next build` compiles all 1113 pages clean. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 3a100c9 commit 3642509

22 files changed

Lines changed: 451 additions & 187 deletions

File tree

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
---
3+
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.
Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
{
22
"title": "AI Protocol",
33
"pages": [
4-
"---Agents & Tools---",
54
"agent",
6-
"tool",
7-
"skill",
85
"conversation",
9-
"mcp",
10-
"---Knowledge & Embeddings---",
11-
"knowledge-source",
12-
"knowledge-document",
136
"embedding",
14-
"---Models & Solutions---",
7+
"knowledge-document",
8+
"knowledge-source",
9+
"mcp",
1510
"model-registry",
11+
"skill",
1612
"solution-blueprint",
13+
"tool",
1714
"usage"
1815
]
19-
}
16+
}
Lines changed: 27 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,43 @@
11
{
22
"title": "API Protocol",
33
"pages": [
4-
"---Overview---",
5-
"protocol",
4+
"analytics",
5+
"auth",
6+
"auth-endpoints",
7+
"automation-api",
8+
"batch",
9+
"connector",
10+
"contract",
611
"core-services",
7-
"documentation",
812
"discovery",
9-
"---REST & HTTP---",
10-
"rest-server",
11-
"router",
13+
"dispatcher",
14+
"documentation",
1215
"endpoint",
13-
"object",
14-
"batch",
16+
"errors",
17+
"events",
1518
"export",
19+
"feed-api",
20+
"graphql",
1621
"http",
1722
"http-cache",
18-
"errors",
19-
"versioning",
20-
"---Query Interfaces---",
21-
"query-adapter",
22-
"graphql",
23-
"odata",
24-
"analytics",
23+
"identity",
2524
"metadata",
2625
"metadata-plugin",
27-
"contract",
28-
"---Auth & Identity---",
29-
"auth",
30-
"auth-endpoints",
31-
"identity",
32-
"---Realtime & Events---",
33-
"realtime",
34-
"realtime-shared",
35-
"websocket",
36-
"events",
37-
"dispatcher",
3826
"notification",
39-
"feed-api",
40-
"---Automation & Integration---",
41-
"automation-api",
42-
"connector",
43-
"plugin-rest-api",
44-
"---Packages & Storage---",
27+
"object",
28+
"odata",
4529
"package-api",
4630
"package-registry",
31+
"plugin-rest-api",
32+
"protocol",
33+
"query-adapter",
34+
"realtime",
35+
"realtime-shared",
4736
"registry",
48-
"storage"
37+
"rest-server",
38+
"router",
39+
"storage",
40+
"versioning",
41+
"websocket"
4942
]
50-
}
43+
}

content/docs/references/api/metadata.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ Metadata query with filtering, sorting, and pagination
314314

315315
| Property | Type | Required | Description |
316316
| :--- | :--- | :--- | :--- |
317-
| **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 |
317+
| **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 |
318318
| **namespaces** | `string[]` | optional | Filter by namespaces |
319319
| **packageId** | `string` | optional | Filter by owning package |
320320
| **search** | `string` | optional | Full-text search query |
@@ -349,7 +349,7 @@ Metadata query with filtering, sorting, and pagination
349349

350350
| Property | Type | Required | Description |
351351
| :--- | :--- | :--- | :--- |
352-
| **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 |
352+
| **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 |
353353
| **name** | `string` || Item name (snake_case) |
354354
| **data** | `Record<string, any>` || Metadata payload |
355355
| **namespace** | `string` | optional | Optional namespace |

content/docs/references/automation/approval.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ const result = ApprovalDecision.parse(data);
7171
| **lockRecord** | `boolean` || Lock the record from editing while pending |
7272
| **approvalStatusField** | `string` | optional | Business-object field to mirror request status onto |
7373
| **escalation** | `Object` | optional | Per-node SLA escalation |
74+
| **maxRevisions** | `integer` || Max send-backs for revision before auto-reject (0 = send-back disabled) |
7475

7576

7677
---
Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
{
22
"title": "Automation Protocol",
33
"pages": [
4-
"---Flows & Execution---",
5-
"flow",
6-
"execution",
7-
"node-executor",
8-
"state-machine",
4+
"approval",
95
"bpmn-interop",
10-
"---Triggers & Jobs---",
11-
"trigger-registry",
6+
"connector",
7+
"etl",
8+
"execution",
9+
"flow",
1210
"job",
13-
"webhook",
11+
"node-executor",
1412
"offline",
15-
"---Workflows & Integration---",
16-
"approval",
17-
"etl",
13+
"state-machine",
1814
"sync",
19-
"connector"
15+
"trigger-registry",
16+
"webhook"
2017
]
21-
}
18+
}

content/docs/references/automation/node-executor.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Canonical cross-paradigm action/node descriptor (ADR-0018)
7676
| **supportsRetry** | `boolean` || Supports retry on failure |
7777
| **needsOutbox** | `boolean` || Dispatch via service-messaging outbox (retry/idempotency/dead-letter) |
7878
| **isAsync** | `boolean` || Suspends the flow awaiting an external reply |
79+
| **maturity** | `Enum<'ga' \| 'beta' \| 'reserved'>` || Runtime maturity: ga (shipped), beta, or reserved (contract only — designers grey this out) |
7980
| **source** | `Enum<'builtin' \| 'plugin'>` || builtin = platform baseline; plugin = third-party contributed |
8081
| **deprecated** | `boolean` || Deprecated alias kept for back-compat |
8182
| **aliasOf** | `string` | optional | Canonical type this alias forwards to |
Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
{
22
"title": "Cloud Protocol",
33
"pages": [
4-
"---Environments---",
4+
"app-store",
5+
"developer-portal",
56
"environment",
67
"environment-artifact",
78
"environment-package",
8-
"provisioning",
9-
"tenant",
10-
"---Marketplace & Distribution---",
119
"marketplace",
1210
"marketplace-admin",
13-
"app-store",
14-
"developer-portal",
15-
"---Packages---",
1611
"package",
1712
"package-version",
13+
"plugin-security",
14+
"provisioning",
1815
"template-manifest",
19-
"plugin-security"
16+
"tenant"
2017
]
21-
}
18+
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"title": "Contracts Protocol",
3+
"pages": []
4+
}
Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,29 @@
11
{
22
"title": "Data Protocol",
33
"pages": [
4-
"---Core Modeling---",
5-
"object",
6-
"field",
7-
"validation",
8-
"mapping",
9-
"document",
10-
"---Query & Filter---",
11-
"query",
12-
"filter",
13-
"date-macros",
144
"analytics",
15-
"---Engine & Drivers---",
165
"data-engine",
176
"datasource",
7+
"date-macros",
8+
"document",
189
"driver",
19-
"driver-sql",
2010
"driver-nosql",
21-
"---Hooks & Lifecycle---",
11+
"driver-sql",
12+
"external-catalog",
13+
"external-lookup",
14+
"feed",
15+
"field",
16+
"filter",
2217
"hook",
2318
"hook-body",
24-
"subscription",
25-
"feed",
19+
"mapping",
2620
"notification",
27-
"---External Data---",
28-
"external-catalog",
29-
"external-lookup",
21+
"object",
22+
"query",
3023
"search-engine",
31-
"---Seeding---",
3224
"seed",
33-
"seed-loader"
25+
"seed-loader",
26+
"subscription",
27+
"validation"
3428
]
35-
}
29+
}

0 commit comments

Comments
 (0)