diff options
| author | Paul Buetow <paul@buetow.org> | 2026-05-18 13:57:47 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-05-18 13:57:47 +0300 |
| commit | 6d54aec98f0a24d9cfa10173f716f05027af10e7 (patch) | |
| tree | 88c00972908db28e418251fee132d55e700fe2aa /player-server/test/e2e-web/tsconfig.json | |
| parent | 0734a296a581917d2fd60e6a1a7aa36ead3a2546 (diff) | |
Rewrite api.md as exhaustive multi-client API contract
- Expanded docs/api.md from 83 lines to full coverage: all 58 registered
routes documented with method, both /api/ and /api/v1/ path aliases,
request/response JSON schemas, status codes, and curl examples
- Added Authentication section: Bearer token vs session cookie, auth
precedence in RequireSession middleware, first-time bootstrap flow
- Added API Versioning section: /api/ (legacy/web) vs /api/v1/ (stable
contract), handleBoth convention, recommendation for mobile clients
- Added Error Envelope section: {error: ...} documented once with full
status code table
- Added Token Lifecycle subsection: minting (one-time plaintext), expiry
enforcement, last_used_at semantics, and revocation behaviour
- Added Range header support documentation for streaming endpoints
- Added Quick Reference table mapping every route to its auth level
- Updated AGENTS.md with two new sections: Bearer-or-cookie unified
middleware pattern in RequireSession, and handleBoth route registration
convention to prevent multi-client contract drift
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Diffstat (limited to 'player-server/test/e2e-web/tsconfig.json')
0 files changed, 0 insertions, 0 deletions
