diff --git a/docs/web-ui/dashboard.md b/docs/web-ui/dashboard.md index ae22d0b3..989b4692 100644 --- a/docs/web-ui/dashboard.md +++ b/docs/web-ui/dashboard.md @@ -720,7 +720,10 @@ re-renders the terminal row. The root agent is addressed as `@root`. The H0M3 hub is the primary landing page (served at `/` by default). A responsive grid of link tiles — Dashboard, Flow, Logs, Matrix (when enabled), -Forge (when enabled) — each pointing to their respective surfaces. The page +Forge (when enabled), among others (Builds, Stats, Settings, Core, +Credentials, API) — each pointing to their respective surfaces. The **API** +tile always shows (unlike Matrix/Forge, see below) and links to the +Swagger UI at `/api/docs`. The page is a pure portal with no tab-bar or SSE subscriptions. Typography + colours inherit from the shared theme (Catppuccin Mocha via `common.css` + `theme.css`). Optional tiles are hidden until `home.js` confirms their availability: @@ -1148,6 +1151,11 @@ that's a browser-level decision, not ours. ## Dashboard endpoints +Also browsable interactively at `/api/docs` (a Swagger UI, linked from +the H0M3 hub's **API** tile), with the raw spec at `/api/openapi.json`. +It's a growing supplement, not yet a full replacement for the list +below — some endpoints aren't in it yet. + - `POST /api/approve/{id}` — approve a pending approval. Fires `ApprovalResolved` on the dashboard event channel; client updates derived approvals state from the event. diff --git a/frontend/packages/dashboard/src/index.html b/frontend/packages/dashboard/src/index.html index cabbc40a..1a15ecf5 100644 --- a/frontend/packages/dashboard/src/index.html +++ b/frontend/packages/dashboard/src/index.html @@ -100,6 +100,17 @@ provision per-agent matrix + github accounts + + + + + API + + interactive OpenAPI spec (Swagger UI) + +