Commit graph

2 commits

Author SHA1 Message Date
jedarden
c3289efcf9 docs(dashboard): enhance API reference with SSE implementation details and storage backend specs
- Add detailed SSE connection behavior and slow client detection
- Add server-side implementation details (broadcast hub, client management)
- Add automatic operations section (downsampling, cleanup, WAL mode)
- Add storage backend details (database, write strategy, query strategy)
- Fix retention period for metrics_5s (24h, not 6h)

Co-Authored-By: Claude <noreply@anthropic.com>
Bead-Id: bf-4rx
2026-06-21 10:32:03 -04:00
jedarden
19e6e9c959 docs(dashboard): add comprehensive API reference documentation
- Document all 5 API endpoints: /healthz, /api/config, /api/status, /api/metrics, /api/events
- Include request parameters, response schemas, and example curl commands
- Document SSE event types and format with code examples in JavaScript and Go
- Add data retention policies, CORS information, and browser usage guidance
- Link to related documentation

Co-Authored-By: Claude <noreply@anthropic.com>
Bead-Id: bf-4rx
2026-06-21 09:59:26 -04:00