View Source OpenApiTypesense.Health (OpenApiTypesense v0.3.0)

Provides API endpoint related to health

Summary

Functions

Checks if Typesense server is ready to accept requests.

Functions

health(opts \\ [])

@spec health(keyword()) :: {:ok, OpenApiTypesense.HealthStatus.t()} | :error

Checks if Typesense server is ready to accept requests.

Checks if Typesense server is ready to accept requests.

health(conn, opts)

@spec health(
  OpenApiTypesense.Connection.t(),
  keyword()
) :: {:ok, OpenApiTypesense.HealthStatus.t()} | :error