Status of this documentation
How the reference is built
Section titled “How the reference is built”The API reference is generated at build time from the OpenAPI contracts in the Quikstik Core repository — the same documents the server’s CI tests the gateway router against. The build:
- reads the gateway’s live route table,
- keeps only operations that are both contracted and routed in production,
- groups them into the sections in the sidebar,
- removes internal design-record references from descriptions.
A contracted operation that is not yet routed does not appear here. A routed operation that is not yet contracted does not appear either; the build reports those so they get contracted.
What is not here yet
Section titled “What is not here yet”- Operator-app surfaces — the inbox, boards, rooms, proposals, suggestions, heartbeat, tasks, threads and per-user settings. They change week to week and are consumed by Quikstik’s own apps. They will be published once they settle.
- Inbound webhooks (
/webhooks/*) — processor and email-provider callbacks into Quikstik; not for integrators. - Outbound webhooks — there is no subscription surface yet. Poll
/bookings,/days/{date}or/money/*for now. - SDKs — none published. The contract is standard OpenAPI 3.0; generated clients work.
Known rough edges in the contracts
Section titled “Known rough edges in the contracts”Some field descriptions in the generated reference still read as design notes (“semantics TBD”, “vocabulary only”). They are accurate about the state of the contract and are being cleaned up contract by contract; the guides in this documentation describe the behaviour that is actually live.
Reporting a discrepancy
Section titled “Reporting a discrepancy”If the documentation and the server disagree, the server wins and the documentation has a bug. Please report it with the request, the response and the page.