Skip to content

docs: Correct Route Domain Index in docs/API.md for mounted prefixes, duplicate entries, and misdescribed routes #5434

Description

@atomantic

Problem

In docs/API.md:551-662 ("Route Domain Index"):

  1. Line 591 lists /identity and /autobiography as top-level mounted route prefixes (| /api/digital-twin/social-accounts, /identity, /autobiography | Digital-twin sub-domains |). In server/index.js:340-341, these sub-routers are mounted at /api/digital-twin/identity and /api/digital-twin/autobiography.
  2. Line 599 describes /api/health as "Health check" (| /api/health | Health check |). However, server/index.js:359 mounts appleHealthRoutes (server/routes/appleHealth.js) at /api/health, providing Apple Health auto-export ingest and XML export imports/metrics (/api/health/ingest, /api/health/metrics/available, /api/health/import/xml, /api/health/correlation). System health checks actually reside under /api/system / /api/system/health (server/routes/systemHealth.js:15).
  3. /api/workspace-contexts is duplicated on line 565 and line 638.
  4. Two mounted API prefixes from server/index.js are omitted from the index:
    • /api/remote-desktop (and /remote-desktop viewer, server/index.js:252, 261, server/routes/remoteDesktop.js, server/routes/remoteDesktopViewer.js)
    • /api/rapid-reader (server/index.js:286, server/routes/rapidReader.js)

Trigger

An operator, API integrator, or coding agent reads docs/API.md Route Domain Index to discover route prefixes or construct endpoint URLs (e.g. attempting to send requests to GET http://localhost:5555/identity or GET http://localhost:5555/autobiography which fail with 404, or hitting GET /api/health expecting a system health ping and receiving an unexpected 404 or schema mismatch).

Impact

Developers and agents encounter 404 errors when following documented digital twin endpoints, confuse Apple Health telemetry with system health monitoring, and cannot find active remote desktop and rapid reader endpoints in the reference index.

Fix

Edit docs/API.md:

  1. On line 591, update /identity and /autobiography to /api/digital-twin/identity and /api/digital-twin/autobiography.
  2. On line 599, update the description for /api/health from "Health check" to "Apple Health metrics, ingest, and XML import".
  3. Remove the duplicate /api/workspace-contexts entry on line 638.
  4. Add entries for /api/remote-desktop, /remote-desktop (PortDeck remote desktop session broker & viewer) and /api/rapid-reader (Rapid reader library and Accelerando source cache) to the Route Domain Index table.
    (Rejected alternative: Leaving /api/health as "Health check" was rejected because /api/health is exclusively mapped to Apple Health metrics in server/routes/appleHealth.js.)

Acceptance criteria

  • docs/API.md lists /api/digital-twin/identity and /api/digital-twin/autobiography instead of /identity and /autobiography.
  • docs/API.md describes /api/health as Apple Health ingest and metrics.
  • /api/workspace-contexts appears exactly once in the Route Domain Index.
  • /api/remote-desktop (and /remote-desktop) and /api/rapid-reader are present in the Route Domain Index.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationeffort:lowEffort: lowmodel:lightModel size: lightplanTracked by /do:replan

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions