Noizu Weaviate
v0.1.1

Noizu.Weaviate.Api.Auth (Noizu Weaviate v0.1.1)

Functions for authentication in the Weaviate API.

Summary

Functions

check_liveness(options \\ nil)

Check if the Weaviate application is alive.

check_readiness(options \\ nil)

Check if the Weaviate application is ready to receive traffic.

get_openid_configuration(options \\ nil)

Get the OpenID configuration in Weaviate.

Functions

Link to this function

check_liveness(options \\ nil)

@spec check_liveness(options :: any()) :: {:ok, any()} | {:error, any()}

Check if the Weaviate application is alive.

Returns

A tuple {:ok, response} on successful API call, where response is the API response. Returns {:error, term} on failure, where term contains error details.

Examples 

{:ok, response} = Noizu.Weaviate.Api.Auth.check_liveness()
Link to this function

check_readiness(options \\ nil)

@spec check_readiness(options :: any()) :: {:ok, any()} | {:error, any()}

Check if the Weaviate application is ready to receive traffic.

Returns

A tuple {:ok, response} on successful API call, where response is the API response. Returns {:error, term} on failure, where term contains error details.

Examples 

{:ok, response} = Noizu.Weaviate.Api.Auth.check_readiness()
Link to this function

get_openid_configuration(options \\ nil)

@spec get_openid_configuration(options :: any()) :: {:ok, any()} | {:error, any()}

Get the OpenID configuration in Weaviate.

Returns

A tuple {:ok, response} on successful API call, where response is the API response. Returns {:error, term} on failure, where term contains error details.

Examples 

{:ok, response} = Noizu.Weaviate.Api.Auth.get_openid_configuration()