Skip to main content

Crate termivar_api

Crate termivar_api 

Source
Expand description

Experimental HTTP adapter for Termivar.

§Runtime scope

  • Build: separate workspace crate (termivar-api).
  • Execution: optional CLI startup hook (termivar-cli/api-adapter). start_api fails nonzero and does not bind a listener; router exposes only GET /health as a library value.
  • Default termivar scan: no.
  • Support: unsupported — no live network listener.

See docs/internals/runtime-map.md.

The implemented alpha surface is deliberately small: router exposes GET /health, while start_api is a startup hook and does not yet bind a network listener.

§Example

let app = termivar_api::router();

Structs§

ApiError
Error returned by the unsupported listener startup hook.

Functions§

health
Returns OK for process-level health checks.
router
Builds the currently implemented Axum router.
start_api
Rejects the unsupported API startup hook.

Type Aliases§

Result
Result returned by the API adapter boundary.