meilisearch_ex v1.1.2

View Source Meilisearch.Version (meilisearch_ex v1.1.2)

Retreive Meilisearch version. Version API

Link to this section Summary

Types

t()

Functions

cast(data)
get(client)

Get a response from the /version endpoint of Meilisearch. Meilisearch documentation

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Meilisearch.Version{
  commitDate: DateTime.t(),
  commitSha: String.t(),
  pkgVersion: String.t()
}

Link to this section Functions

Link to this function

cast(data)

View Source
Link to this function

get(client)

View Source 
@spec get(Tesla.Client.t()) :: {:ok, t()} | {:error, Meilisearch.Client.error()}

Get a response from the /version endpoint of Meilisearch. Meilisearch documentation

examples

 Examples 

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Version.get(client)
{:ok, %{
  commitSha: "b46889b5f0f2f8b91438a08a358ba8f05fc09fc1",
  commitDate: ~U[2019-11-15 09:51:54.27Z],
  pkgVersion: "0.1.1"
}}