docs: use canonical State Hub reads with caller attribution
All checks were successful
CI Smoke / host-smoke (push) Successful in 0s
CI Smoke / container-smoke (push) Successful in 1s

Assistant: codex
Assistant-Model: gpt-6-astra
Assistant-Session: 01a06ed7-828d-7ca0-a8d4-0c3e5a0c4102
This commit is contained in:
tegwick 2026-09-05 10:24:19 +02:00
parent 37b8f39bd0
commit 96dbb22aab

View file

@ -221,6 +221,19 @@ Install bundled memory: `make install-all` then `make check-memory` from
## Workplan Convention (ADR-001)
### State Hub reads and caller identity
Use `GET /workplans/{id}` and `GET /tasks/?workplan_id=<id>` for reads.
Do not send the legacy `workstream_id` query parameter or call `/workstreams/`
routes (410 Gone). Keep `state_hub_workstream_id` in file frontmatter unchanged.
Send `X-StateHub-Component: ops-warden` on direct HTTP requests so operational
reviews can attribute callers. Example:
```bash
curl -fsS -H 'X-StateHub-Component: ops-warden' \
'http://127.0.0.1:8000/tasks/?workplan_id=<workplan-uuid>'
```
Work items originate as files in this repo — not in the hub. The hub is a
read/cache/index layer that rebuilds from files.