Commit 84b4a3a
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
134 | 134 | | |
135 | 135 | | |
136 | 136 | | |
137 | | - | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
138 | 141 | | |
139 | 142 | | |
140 | 143 | | |
| |||
0 commit comments