OpenApiTypesense.Health (OpenApiTypesense v0.7.0)

View Source

Provides API endpoint related to health

Summary

Functions

Checks if Typesense server is ready to accept requests.

Either one of

Either one of

Functions

health()

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

Checks if Typesense server is ready to accept requests.

Checks if Typesense server is ready to accept requests.

health(opts)

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

Either one of:

  • health(opts)
  • health(%{api_key: xyz, host: ...})
  • health(Connection.new())

health(conn, opts)

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

Either one of:

  • health(%{api_key: xyz, host: ...}, opts)
  • health(Connection.new(), opts)