Files
trixie-api/README.md
T

15 lines
763 B
Markdown

# Trixie API
Shared versioned HTTP and authenticated WebSocket contracts for `trixie-server` and `trixy-linux-client`.
This repository contains schemas, shared enums, error codes, compatibility fixtures, contract tests, and API documentation only.
The first contract slice is under `contracts/v1/` and `fixtures/v1/`. It covers
server readiness, health, errors, and the transport-neutral realtime event
envelope so the client and server can be developed and tested together before
Twitch integration. It also defines the first administrator authentication
request and response envelopes; bearer values in fixtures are synthetic only.
Twitch OAuth link and completion response envelopes are also versioned here;
fixtures contain no real credentials or tokens.