Update docs to reflect camelCase JSON key convention

ccfb5fd→main·

Soph·3mo ago·2 files·+8 added/-8 removed

Co-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com

Sessions

fac14075b0f9View transcript

Changes

2

• MREADME.md+6/-6

• docs

• Membedding.md+2/-2

346 unmodified lines

347
348
349
350
350
351
352
353
354
355
356
352
353
354
355
356
357
358
359

346 unmodified lines

The JSON interface is intentionally stable:

- keys use `snake_case`
- keys use `camelCase`
- refs and hashes are serialized as strings, not raw byte arrays
- `probe` returns top-level keys such as `source_url`, `target_url`, `protocol`, `ref_prefixes`, `source_capabilities`, `target_capabilities`, `refs`, and `stats`
- `fetch` returns top-level keys such as `source_url`, `protocol`, `wants`, `haves`, `fetched_objects`, and `stats`
- `bootstrap`, `plan`, and `sync` return top-level keys such as `plans`, `pushed`, `skipped`, `blocked`, `deleted`, `dry_run`, `protocol`, and `stats`
- `bootstrap`, `plan`, and `sync` also expose `relay`, `relay_mode`, `relay_reason`, `batching`, `batch_count`, `planned_batch_count`, and `temp_refs`
- each item in `plans` includes stable string fields such as `branch`, `source_ref`, `target_ref`, `source_hash`, `target_hash`, `kind`, `action`, and `reason`
- `probe` returns top-level keys such as `sourceUrl`, `targetUrl`, `protocol`, `refPrefixes`, `sourceCapabilities`, `targetCapabilities`, `refs`, and `stats`
- `fetch` returns top-level keys such as `sourceUrl`, `protocol`, `wants`, `haves`, `fetchedObjects`, and `stats`
- `bootstrap`, `plan`, and `sync` return top-level keys such as `plans`, `pushed`, `skipped`, `blocked`, `deleted`, `dryRun`, `protocol`, and `stats`
- `bootstrap`, `plan`, and `sync` also expose `relay`, `relayMode`, `relayReason`, `batching`, `batchCount`, `plannedBatchCount`, and `tempRefs`
- each item in `plans` includes stable string fields such as `branch`, `sourceRef`, `targetRef`, `sourceHash`, `targetHash`, `kind`, `action`, and `reason`

## Auth

MREADME.md+6/-6

118 unmodified lines

119
120
121
122
123
122
123
124
125
126

118 unmodified lines

- `Counts`
  aggregate applied/skipped/blocked/deleted totals
- `Execution`
  protocol, `operation_mode` (sync or replicate), relay summary,
  `transfer_mode` (the engine path that executed), and batch summary
  protocol, `operationMode` (sync or replicate), relay summary,
  `transferMode` (the engine path that executed), and batch summary
- `Stats`
  transfer counters when requested
- `Measurement`