Skip to content

Commit 5b1b530

Browse files
committed
docs(spec): move the two hand-kept schema counts and four @example keys onto the epoch rename (#15676)
Adding `src/shared/epoch.zod.ts` and its generated reference page moved two counts that no generator re-derives, and left four JSDoc `@example` blocks teaching keys this branch turned into tombstones. The counts (both re-derived by gates, both hand-kept by design): - `packages/spec/llms.txt` schema-inventory heading 207 -> 208 and the `shared` row 13 -> 14. Per that gate's header the number is not the claim, the prose beside it is: the row's Key Schemas cell now names the epoch instant, so the sentence and the count say the same thing. - `content/docs/getting-started/quick-reference.mdx` "Shared Protocol" (5 of 8) -> (5 of 9). Only M moves: the table is a curated subset by that page's own stated rule, so N stays 5 and no row is added. The examples (no gate reads a JSDoc `@example`, so each was classified in context by reading the schema it documents): - `WebSocketEventSchema`'s two examples: `timestamp` -> `occurredAt`. - `HealthStatusSchema`'s example: `"timestamp"` -> `"checkedAt"`. - `PluginStartupResultSchema`'s example: the nested `health.timestamp` -> `"checkedAt"` — `health` carries `HealthStatusSchema`, so it is the same renamed key. Its sibling `"duration"` is untouched. No key name, describe, meta, schema shape, tombstone, disposition, retired-key row, conversion or changeset changes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01G4138K1EG7kQ81FNba5Kp4
1 parent 9605808 commit 5b1b530

4 files changed

Lines changed: 7 additions & 7 deletions

File tree

content/docs/getting-started/quick-reference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ from the provider itself, not from hand-written spec files.
206206
|:---------|:-----------|:------------|:--------|
207207
| **[Connector](/docs/references/integration/connector)** | `connector.zod.ts` | Connector | The connector protocol — auth, sync, webhooks, rate limiting |
208208

209-
## Shared Protocol (5 of 8 schemas)
209+
## Shared Protocol (5 of 9 schemas)
210210

211211
Common utilities used across all protocols.
212212

packages/spec/llms.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ const query = {
7777

7878
---
7979

80-
## 3. Schema Inventory by Domain (207 schemas)
80+
## 3. Schema Inventory by Domain (208 schemas)
8181

8282
Counted as `*.zod.ts` modules under `packages/spec/src/<domain>/` — the sources
8383
that ship in this tarball (`files` includes `src/**/*.zod.ts`), so every number
@@ -91,7 +91,7 @@ here is verifiable from the installed package.
9191
| api | 30 | Endpoint, REST Server, Discovery, OData, Batch, WebSocket, Response Envelope, Package Lifecycle |
9292
| ui | 18 | View, App, Action, Dashboard, Page, Chart, Component, Animation |
9393
| automation | 13 | Flow, Approval, BPMN Interop, Control Flow, State Machine, Webhook |
94-
| shared | 13 | Enums, HTTP, Identifiers, Mapping, Metadata Types, Connector Auth, Retry Policy, Value Domain |
94+
| shared | 14 | Enums, HTTP, Identifiers, Mapping, Metadata Types, Connector Auth, Retry Policy, Value Domain, Epoch Instant (EpochMs) |
9595
| ai | 11 | Agent, Conversation, Knowledge Source/Document, Model Registry, MCP, Skill, Tool |
9696
| cloud | 11 | Marketplace, Developer Portal, App Store, Environment, Package, Tenant |
9797
| identity | 5 | Identity, Organization, Position, SCIM, Eval User |

packages/spec/src/api/websocket.zod.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ export type WebSocketConfigParsed = z.infer<typeof WebSocketConfigSchema>;
447447
* type: 'subscribe',
448448
* channel: 'record.account.123',
449449
* payload: { events: ['created', 'updated'] },
450-
* timestamp: Date.now()
450+
* occurredAt: Date.now()
451451
* }
452452
* ```
453453
*
@@ -457,7 +457,7 @@ export type WebSocketConfigParsed = z.infer<typeof WebSocketConfigSchema>;
457457
* type: 'data-change',
458458
* channel: 'record.account.123',
459459
* payload: { id: '123', action: 'updated', data: {...} },
460-
* timestamp: Date.now()
460+
* occurredAt: Date.now()
461461
* }
462462
* ```
463463
*/

packages/spec/src/kernel/startup-orchestrator.zod.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export type StartupOptionsParsed = z.infer<typeof StartupOptionsSchema>;
8181
* @example
8282
* {
8383
* "healthy": true,
84-
* "timestamp": 1706659200000,
84+
* "checkedAt": 1706659200000,
8585
* "details": {
8686
* "databaseConnected": true,
8787
* "memoryUsage": 45.2
@@ -137,7 +137,7 @@ export type HealthStatus = z.input<typeof HealthStatusSchema>;
137137
* "duration": 1250,
138138
* "health": {
139139
* "healthy": true,
140-
* "timestamp": 1706659200000
140+
* "checkedAt": 1706659200000
141141
* }
142142
* }
143143
*/

0 commit comments

Comments
 (0)