ReaperOfVeriod bb9b00295f
API checks / checks (push) Canceled after 0s
API dependency and security checks / audit (push) Canceled after 0s
Add Guest Star settings contract
2026-10-25 05:52:19 +01:00
2026-10-25 03:42:56 +01:00
2026-10-25 03:42:56 +01:00
2026-10-25 03:45:44 +01:00
2026-10-25 05:52:19 +01:00
2026-10-25 03:42:56 +01:00

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.

The shared boundary vocabulary includes the ordered permission levels in contracts/v1/permissions.json and the client/server compatibility result in contracts/v1/version-negotiation.json. Server-owned state is delivered as the authenticated realtime-event.json envelope; clients must ignore event types they do not understand.

Guest Star channel settings are described by contracts/v1/guest-star-channel-settings-response.json. The browser-source token is a server-to-authenticated-client value and fixtures use a synthetic placeholder only.

S
Description
Trixie shared API contracts
Readme MIT
136 KiB
Languages
Python 100%