ExBifrost.Api.Health (ex_bifrost v0.1.0)

Copy Markdown View Source

API calls for all endpoints tagged Health.

Summary

Functions

get_health(connection, opts \\ [])

Health check Returns the health status of the Bifrost server. Checks connectivity to config store, log store, and vector store if configured.

Functions

get_health(connection, opts \\ [])

@spec get_health(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, ExBifrost.Model.BifrostError.t()}
  | {:ok, ExBifrost.Model.HealthResponse.t()}
  | {:error, Tesla.Env.t()}

Health check Returns the health status of the Bifrost server. Checks connectivity to config store, log store, and vector store if configured.

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExBifrost.Model.HealthResponse.t} on success
  • {:error, Tesla.Env.t} on failure