Skip to content

Commit a2f47ba

Browse files
committed
docs(spec): regenerate protocol.mdx for droppedFields response fields (#3431)
`content/docs/references/api/protocol.mdx` is generated from the spec Zod schemas (build-docs.ts) and is checked in; the new optional `droppedFields` on Create/Update DataResponse must be regenerated so `check:docs` (run inside the TypeScript Type Check job) stays green. Generated output only — no hand-edits. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NNqeAmxCCq9jgLFwa9subq
1 parent 91f01c5 commit a2f47ba

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

content/docs/references/api/protocol.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,7 @@ const result = AiInsightsRequest.parse(data);
219219
| **object** | `string` || The object name. |
220220
| **id** | `string` || The ID of the newly created record. |
221221
| **record** | `Record<string, any>` || The created record, including server-generated fields (created_at, owner). |
222+
| **droppedFields** | `{ object: string; fields: string[]; reason: Enum<'readonly' \| 'readonly_when'> }[]` | optional | Write-observability (#3407/#3431): caller-supplied fields that were LEGALLY stripped before the record was written — a non-system create cannot seed a static `readonly` column (#3043 ingress strip), so those keys are dropped and the field re-derives its default. Present ONLY when ≥1 field was dropped; the create still succeeded without them (status/success semantics unchanged). REST additionally surfaces this as the `X-ObjectStack-Dropped-Fields` response header. Optional — omit-when-empty keeps the shape backward-compatible for existing clients. |
222223

223224

224225
---
@@ -1179,6 +1180,7 @@ const result = AiInsightsRequest.parse(data);
11791180
| **object** | `string` || Object name |
11801181
| **id** | `string` || Updated record ID |
11811182
| **record** | `Record<string, any>` || Updated record |
1183+
| **droppedFields** | `{ object: string; fields: string[]; reason: Enum<'readonly' \| 'readonly_when'> }[]` | optional | Write-observability (#3407/#3431): caller-supplied fields the engine LEGALLY stripped from the write before persisting — static `readonly` (#2948) or a TRUE `readonlyWhen` predicate (#3042). Present ONLY when ≥1 field was dropped; the update still succeeded without them (status/success semantics unchanged — stripping is legitimate, not an error). REST additionally surfaces this as the `X-ObjectStack-Dropped-Fields` response header. Optional — omit-when-empty keeps the shape backward-compatible for existing clients that only read `record`. |
11821184

11831185

11841186
---

0 commit comments

Comments
 (0)