Skip to content

Commit 84b4a3a

Browse files
authored
docs(client): drop the retired validateOnly batch option from the README (#4443)
The Batch Options section documented `validateOnly` as a working dry-run — "validate records without persisting changes" — but the key was retired in #4052 precisely because nothing ever read it. Every batch surface (updateManyData / deleteManyData / batchData) persisted regardless, so a caller who sent it to preview a mutation got that mutation executed. BatchOptionsSchema has carried a retiredKey(...) tombstone since #4052, so the schema already refuses the key loudly. The README was the last place still promising it — declared-but-not-enforced in prose rather than in code, aimed at exactly the readers who cannot see the tombstone. Replaced with a pointer to docs/protocol-upgrade-guide.md (batch-options-validate-only-retired). No behaviour change; there is no batch dry-run today. Shipped as a patch because README.md is in this package's `files`, so the correction only reaches npmjs.com readers if it releases. Found while evaluating #4372 (write-path validate-only mode), closed as not planned — no current consumer justifies the surface.
1 parent 4bee182 commit 84b4a3a

2 files changed

Lines changed: 29 additions & 1 deletion

File tree

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
'@objectstack/client': patch
3+
---
4+
5+
docs(client): drop the retired `validateOnly` batch option from the README (#4052)
6+
7+
The Batch Options section still documented `validateOnly` as a working dry-run —
8+
"validate records without persisting changes" — but the key was retired in #4052
9+
precisely because nothing ever read it. Every batch surface (`updateManyData` /
10+
`deleteManyData` / `batchData`) persisted regardless, so a caller who sent it to
11+
preview a mutation got that mutation **executed**.
12+
13+
`BatchOptionsSchema` has carried a `retiredKey(...)` tombstone since #4052, so the
14+
schema already refuses the key loudly. The README was the last place still
15+
promising it — declared-but-not-enforced in prose rather than in code, aimed at
16+
exactly the readers who cannot see the tombstone.
17+
18+
Released as a patch rather than declared release-nothing because `README.md` is in
19+
this package's `files`: the corrected text only reaches the people who hit the
20+
problem — readers on npmjs.com — if the package ships.
21+
22+
Replaced with a pointer to `docs/protocol-upgrade-guide.md`
23+
(`batch-options-validate-only-retired`). No behaviour change; there is no batch
24+
dry-run today. Write-path validate-only was evaluated in #4372 and closed as not
25+
planned — no current consumer justifies the surface.

packages/client/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,10 @@ Batch operations support the following options:
134134
- `atomic`: If true, rollback entire batch on any failure (default: true).
135135
- `returnRecords`: If true, return full record data in response (default: false).
136136
- `continueOnError`: If true (and atomic=false), continue processing remaining records after errors.
137-
- `validateOnly`: If true, validate records without persisting changes (dry-run mode).
137+
138+
> `validateOnly` was retired in #4052 — it was never implemented and batch surfaces persisted
139+
> regardless, so there is no batch dry-run today. Drop the key; see
140+
> `docs/protocol-upgrade-guide.md` (`batch-options-validate-only-retired`).
138141
139142
### Error Handling
140143
The client provides standardized error handling with machine-readable error codes:

0 commit comments

Comments
 (0)