docs · reference

packages/contracts — the law

zod schemas for every request, response, WebSocket event and DB entity. no API shape exists that isn't declared here.

packages/contracts is written first and is the law. every request, response, WebSocket event and DB entity has a zod schema — and no API surface exists that hasn't been declared there.

the rules:

contracts are generated into an OpenAPI spec, which generates the typed SDK the terminal and mobile app consume.
breaking changes bump the path version (/v2/...) and update CHANGELOG.md. never mutate silently.
when the terminal or mobile client needs a new API surface, it opens a request in /coordination/requests/ and continues with a mock until the backend lands.

← back to docs

packages/contracts — the law

start when we're ready.