Expand description
Ready route module.
This module provides the readiness endpoint (GET /ready) for the daemon.
The ready endpoint is side-effect free and provides a deterministic response
indicating daemon readiness. It reflects whether the daemon has completed
bootstrap and is fully operational.
§Invariant boundaries
The ready handler performs no IO, reads no storage, and mutates no runtime state. It reflects the bootstrap state and is constant-time.
§Response schema
When ready: {"status": "ready"}
When not ready: {"status": "<reason>"}
The status is “ready” when the daemon has completed bootstrap. Otherwise, it includes a reason string indicating why the daemon is not yet ready.
§Readiness vocabulary (WP-2)
The only allowed not-ready reasons in WP-2 are:
ReadyStatus::REASON_CONFIG_INVALID: Configuration was invalid during bootstrap.ReadyStatus::REASON_BOOTSTRAP_INCOMPLETE: Bootstrap process was incomplete.
These reasons are defined as static constants on ReadyStatus.
Structs§
- Ready
Response - Ready check response payload.
Functions§
- handle
- Ready check handler.
- register_
routes - Registers the ready route in the router builder.