Layr8.REST (layr8 v0.3.2)

Internal HTTP client for the Layr8 cloud-node REST API.

Uses Req for HTTP requests. Authentication is via x-api-key header.

Not intended for direct use; accessed through Layr8.Credentials, Layr8.Presentations and Layr8.Mediation.

Summary

Types

t()

Functions

delete(client, path, opts \\ [])

Issues a DELETE request to path. {:ok, body} (body may be empty) or {:error, term()}.

get(client, path, opts \\ [])

Issues a GET request to path and returns the decoded response.

new(base_url, api_key, opts \\ [])

Creates a new REST client.

post(client, path, body, opts \\ [])

Issues a JSON POST request to path with body and returns the decoded response.

post_didcomm(url, jwe, opts \\ [])

Posts a packed DIDComm message (the JWE bytes) to a node's public /didcomm ingress — the re-injection step of Layr8.Mediation. No API key: the ingress authenticates the message itself.

put(client, path, body, opts \\ [])

Issues a JSON PUT request to path with body. Same contract as post/4.

Types

t()

@type t() :: %Layr8.REST{
  api_key: String.t(),
  base_url: String.t(),
  timeout_ms: non_neg_integer()
}

Functions

delete(client, path, opts \\ [])

@spec delete(t(), String.t(), keyword()) :: {:ok, term()} | {:error, term()}

Issues a DELETE request to path. {:ok, body} (body may be empty) or {:error, term()}.

get(client, path, opts \\ [])

@spec get(t(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}

Issues a GET request to path and returns the decoded response.

Options

:timeout_ms — deadline on the response. 0 or nil leaves the call unbounded, which is the pre-existing behaviour.

Returns {:ok, map()} on success or {:error, term()} on failure.

new(base_url, api_key, opts \\ [])

@spec new(String.t(), String.t(), keyword()) :: t()

Creates a new REST client.

Parameters

base_url — HTTP base URL of the cloud-node (e.g. "https://node.example.com")
api_key — API key for authentication

Options

:timeout_ms — default deadline on every call made through this client. 0 leaves them unbounded. See Layr8.Config.default_rest_timeout_ms/0 for why the default is a deadline at all: Req has none of its own, so a node that accepted the connection and went quiet left every credential and presentation call hanging — neither resolving nor failing, and never letting the caller reach the point of deciding to retry.

post(client, path, body, opts \\ [])

@spec post(t(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, term()}

Issues a JSON POST request to path with body and returns the decoded response.

Options

:timeout_ms — deadline on the response. 0 or nil leaves the call unbounded, which is the pre-existing behaviour.

Returns {:ok, map()} on success or {:error, term()} on failure.

post_didcomm(url, jwe, opts \\ [])

@spec post_didcomm(String.t(), binary(), keyword()) :: :ok | {:error, term()}

Posts a packed DIDComm message (the JWE bytes) to a node's public /didcomm ingress — the re-injection step of Layr8.Mediation. No API key: the ingress authenticates the message itself.

put(client, path, body, opts \\ [])

@spec put(t(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, term()}

Issues a JSON PUT request to path with body. Same contract as post/4.