exlab_wizard.api.health

GET /api/v1/health rollup. Backend Spec §4.6.3.

Returns a component-health snapshot regardless of setup state. The endpoint is the launcher’s “is the server up” probe and the Settings dialog’s diagnostics surface. Per spec the HTTP status is always 200; the top-level status field is the contract.

The component statuses are read from the bound AppDependencies where available (validator, NAS sync queue, plugin registry, session store). Components that are not wired in a test or stub scenario report status == "ok" with the component-specific reason field absent.

Functions

build_health_router()

Construct the health router.

Classes

HealthResponse(**data)

GET /health response body.

class exlab_wizard.api.health.HealthResponse(**data)

Bases: BaseModel

GET /health response body. Backend Spec §4.6.3.

Parameters:

data (Any)

components: dict[str, dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

schema_versions: dict[str, str]

setup_state: str

status: str

version: str

exlab_wizard.api.health.build_health_router()

Construct the health router. Always available.

Return type:

APIRouter