Commit 83b61c9
committed
docs(api): true up the batch
The docs-drift check flagged the hand-written API docs, and three of them were
genuinely stale — they documented the bug ADR-0118 D4 fixes:
- `wire-format.mdx` stated it outright: "By default (`options.atomic: true`)
processing stops at the first failing record — records already written
earlier in the same batch are **not** rolled back, since there is no wrapping
database transaction." Accurate before, wrong on both halves now.
- `client-sdk.mdx`'s options table listed `atomic` default `true` with
"Rollback entire batch on any failure" — the default moved, and the rollback
claim only became true with this change.
- `data-api.mdx` described `atomic` as the default on `/batch` and `deleteMany`.
Each now describes what the route actually does, including the 501 refusal and
the rolled-back response shape (`succeeded: 0`, ROLLED_BACK / NOT_ATTEMPTED).
Kept honest about scope: `deleteMany` and `updateMany` did NOT get D4's
treatment, so `deleteMany`'s note now says plainly that its `atomic` only stops
the run and rolls nothing back (#4620 tracks the fix). Documenting the fixed
behaviour on routes that still carry the bug would have replaced one inaccuracy
with another.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NKcGqCYCCpMkB5UW8jNPXxatomic docs that D4 made wrong (#4612)1 parent 7236bb0 commit 83b61c9
3 files changed
Lines changed: 23 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
504 | 504 | | |
505 | 505 | | |
506 | 506 | | |
507 | | - | |
| 507 | + | |
508 | 508 | | |
509 | | - | |
| 509 | + | |
| 510 | + | |
| 511 | + | |
| 512 | + | |
| 513 | + | |
510 | 514 | | |
511 | 515 | | |
512 | 516 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
228 | 228 | | |
229 | 229 | | |
230 | 230 | | |
| 231 | + | |
| 232 | + | |
231 | 233 | | |
232 | 234 | | |
233 | 235 | | |
| |||
260 | 262 | | |
261 | 263 | | |
262 | 264 | | |
263 | | - | |
| 265 | + | |
264 | 266 | | |
265 | 267 | | |
266 | 268 | | |
267 | 269 | | |
268 | 270 | | |
269 | 271 | | |
270 | | - | |
271 | | - | |
272 | | - | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
273 | 279 | | |
274 | 280 | | |
275 | 281 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
471 | 471 | | |
472 | 472 | | |
473 | 473 | | |
474 | | - | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
| 477 | + | |
| 478 | + | |
475 | 479 | | |
476 | 480 | | |
477 | 481 | | |
| |||
483 | 487 | | |
484 | 488 | | |
485 | 489 | | |
486 | | - | |
| 490 | + | |
487 | 491 | | |
488 | 492 | | |
489 | 493 | | |
| |||
509 | 513 | | |
510 | 514 | | |
511 | 515 | | |
512 | | - | |
| 516 | + | |
513 | 517 | | |
514 | 518 | | |
515 | 519 | | |
| |||
0 commit comments