This section is the contract written down: what every route takes and answers, what each status code and error code tells your client to do, every setting with the default the code applies, and the limits you will meet first. It describes server 2.0.0.
Several tables here are generated from the Rust at build time (the route table, the environment
variables server/src/config.rs reads, the metric families). The build fails when one of them
falls behind the code, so those cannot quietly go stale. Everything else on these pages was checked
by hand against the same source, and each page lists the files it describes.
| Page | What it answers |
|---|---|
| HTTP API | Base URL, which node to call, authentication, status codes, every route, reads by offset, the control-plane API, the OpenAPI documents. |
| Transaction | Every field of POST /api/v1/transaction, its results, every rollback reason, when a retry is safe. |
| Configuration | The environment variables of the broker, its engine and the embedded proxy, with the defaults the code applies. |
| Metrics | Every Prometheus family GET /metrics/prometheus exposes. |
| Errors | Error bodies and codes across the API, and what a client does with each. |
| Limits | Sizes, name rules, windows and defaults, each with the setting that moves it. |
| Kafka | Every QUEEN_KAFKA_* setting, topic configs, the APIs and versions the facade answers, where it differs from Apache Kafka, and notes on tested clients. |
| queenctl | The command-line client: install, connect, every command group. |