Backplane.SkillProtocol.Client (backplane_skill_protocol v1.0.0)

Instance-scoped, bounded client for the Skill Protocol v1 read API.

Summary

Types

t()

Functions

artifact(client, ref, opts \\ [])

catalog(client, opts \\ [])

new(opts)

new!(opts)

resolve(client, skill_id, revision \\ nil, opts \\ [])

Types

t()

@type t() :: %Backplane.SkillProtocol.Client{
  access_context_id: term(),
  cancelled?: term(),
  clock: term(),
  credential_supplier: term(),
  endpoint: term(),
  max_artifact_bytes: term(),
  max_attempts: term(),
  max_json_bytes: term(),
  overall_timeout_ms: term(),
  retry_delays_ms: term(),
  sleep: term(),
  source_id: term(),
  transport: term()
}

Functions

artifact(client, ref, opts \\ [])

@spec artifact(t(), Backplane.SkillProtocol.SkillRef.t(), keyword()) ::
  {:ok, binary()} | {:error, Backplane.SkillProtocol.Error.t()}

catalog(client, opts \\ [])

@spec catalog(
  t(),
  keyword()
) :: {:ok, map()} | {:error, Backplane.SkillProtocol.Error.t()}

new(opts)

@spec new(keyword()) :: {:ok, t()} | {:error, Backplane.SkillProtocol.Error.t()}

new!(opts)

@spec new!(keyword()) :: t()

resolve(client, skill_id, revision \\ nil, opts \\ [])

@spec resolve(t(), String.t(), String.t() | nil, keyword()) ::
  {:ok, Backplane.SkillProtocol.BundleManifest.t()}
  | {:error, Backplane.SkillProtocol.Error.t()}