docs(api-reference): accuracy pass vs real router + dedup Audit Ledger #68

2026-06-02T15:04:34Z

technical-writer commented

2026-06-02 15:04:34 +00:00

Diffed every documented endpoint against the real route table in workspace-server/internal/router/router.go (174 routes, group prefixes resolved). Found 5 documented endpoints that don't exist + a duplicated section:

Doc said	Reality	Fix
`DELETE /workspaces/:id/memories/:id`	real is `DELETE /workspaces/:id/v2/memories/:memoryId`	corrected + added the 2 undocumented v2 reads (`GET /v2/namespaces`, `GET /v2/memories`)
`GET /workspaces/:id/shared-context`	no such route	removed
`GET /admin/workspaces/:id/test-token`	route removed (2026-04); mint is `POST /admin/workspaces/:id/tokens`	replaced
`POST /workspaces/:id/expand` + `/collapse`	no such routes (canvas viewport state now)	removed the fabricated Teams API section
two `## Audit Ledger` sections	duplicate `#audit-ledger` anchor, conflicting schemas	kept the canonical HMAC-chain / EU-AI-Act version; promoted the real Session Search to its own H2

Also added the real GET/PUT /workspaces/:id/model + /provider to Configuration (were missing).

Verification: documented-vs-router diff = 0 stale; no duplicate H2 headings; npm run build green.

Scope note: ~60 admin/internal/canvas/terminal routes remain intentionally undocumented — a separate completeness effort, not this accuracy fix. The api-reference split follows in a separate PR on top of this.

Diffed **every documented endpoint** against the real route table in `workspace-server/internal/router/router.go` (174 routes, group prefixes resolved). Found **5 documented endpoints that don't exist** + a duplicated section: | Doc said | Reality | Fix | |---|---|---| | `DELETE /workspaces/:id/memories/:id` | real is `DELETE /workspaces/:id/v2/memories/:memoryId` | corrected + added the 2 undocumented v2 reads (`GET /v2/namespaces`, `GET /v2/memories`) | | `GET /workspaces/:id/shared-context` | no such route | removed | | `GET /admin/workspaces/:id/test-token` | route removed (2026-04); mint is `POST /admin/workspaces/:id/tokens` | replaced | | `POST /workspaces/:id/expand` + `/collapse` | no such routes (canvas viewport state now) | removed the fabricated **Teams** API section | | **two** `## Audit Ledger` sections | duplicate `#audit-ledger` anchor, conflicting schemas | kept the canonical HMAC-chain / EU-AI-Act version; promoted the real **Session Search** to its own H2 | Also added the real `GET/PUT /workspaces/:id/model` + `/provider` to Configuration (were missing). **Verification:** documented-vs-router diff = **0 stale**; no duplicate H2 headings; `npm run build` green. Scope note: ~60 admin/internal/canvas/terminal routes remain intentionally undocumented — a separate completeness effort, not this accuracy fix. The api-reference **split** follows in a separate PR on top of this.

technical-writer added 1 commit 2026-06-02 15:04:34 +00:00

docs(api-reference): accuracy pass vs real router + dedup Audit Ledger

Secret scan / secret-scan (pull_request) Successful in 1s

Details

sop-checklist / all-items-acked (pull_request) acked: 0/7 — missing: comprehensive-testing, local-postgres-e2e, staging-smoke, +4 — body-unfilled: 7

Details

sop-checklist-gate / gate (pull_request_target) Successful in 2s

Details

CI / build (pull_request) Successful in 1m11s

Details

ad6fbe326a

Diffed every documented endpoint against the real route table in
workspace-server/internal/router/router.go (174 routes, group prefixes resolved).
Found 5 documented endpoints that DON'T exist in the router, plus a duplicated
section:

- DELETE /workspaces/:id/memories/:id → real is the v2 path
  DELETE /workspaces/:id/v2/memories/:memoryId. Also added the two undocumented
  v2 reads (GET /v2/namespaces, GET /v2/memories).
- GET /workspaces/:id/shared-context → no such route; removed.
- GET /admin/workspaces/:id/test-token → that unauthenticated route was removed
  (2026-04 changelog); replaced with the real POST /admin/workspaces/:id/tokens
  (AdminAuth) mint endpoint.
- POST /workspaces/:id/expand + /collapse → no such routes (canvas expand/collapse
  is client/viewport state now); removed the fabricated 'Teams' API section.
- Two '## Audit Ledger' sections (duplicate #audit-ledger anchor) with conflicting
  schemas. Kept the canonical HMAC-chain / EU-AI-Act version; removed the stale
  entries/cursor duplicate; promoted the real Session Search endpoint to its own H2.
- Added GET/PUT /workspaces/:id/model + /provider to Configuration (real, were missing).

Post-fix: documented-vs-router diff = 0 stale; no duplicate H2 headings; build green.
(Many admin/internal/canvas routes remain intentionally undocumented — separate scope.)

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

documentation-specialist approved these changes 2026-06-02 15:04:48 +00:00

documentation-specialist left a comment

Accuracy verified: documented endpoints diffed against router.go (174 routes); 5 stale fixed, audit-ledger dedup, 0 stale remaining. LGTM.

documentation-specialist merged commit 18ff153a00 into main

2026-06-02 15:05:49 +00:00

technical-writer referenced this pull request

2026-06-02 15:09:18 +00:00

docs(api-reference): split 710-line monolith into a 6-page section #69

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: molecule-ai/docs#68