Document API ownership boundary
This commit is contained in:
@@ -4,6 +4,10 @@ Shared versioned HTTP and authenticated WebSocket contracts for `trixie-server`
|
|||||||
|
|
||||||
This repository contains schemas, shared enums, error codes, compatibility fixtures, contract tests, and API documentation only.
|
This repository contains schemas, shared enums, error codes, compatibility fixtures, contract tests, and API documentation only.
|
||||||
|
|
||||||
|
The API repository is the boundary between the server authority and the Linux
|
||||||
|
client presentation layer. It contains no Twitch credentials, database logic,
|
||||||
|
or UI behavior.
|
||||||
|
|
||||||
The first contract slice is under `contracts/v1/` and `fixtures/v1/`. It covers
|
The first contract slice is under `contracts/v1/` and `fixtures/v1/`. It covers
|
||||||
server readiness, health, errors, and the transport-neutral realtime event
|
server readiness, health, errors, and the transport-neutral realtime event
|
||||||
envelope so the client and server can be developed and tested together before
|
envelope so the client and server can be developed and tested together before
|
||||||
|
|||||||
Reference in New Issue
Block a user