Codex.Protocol.Plugin.Summary (Codex SDK v0.16.1)

Copy Markdown View Source

Plugin summary metadata returned by plugin/list and plugin/read.

Summary

Types

t()

Functions

from_map(data)
parse(value)
parse!(value)
schema()
to_map(value)

Types

t()

@type t() :: %Codex.Protocol.Plugin.Summary{
  auth_policy: Codex.Protocol.Plugin.AuthPolicy.t(),
  enabled: boolean(),
  extra: map(),
  id: String.t(),
  install_policy: Codex.Protocol.Plugin.InstallPolicy.t(),
  installed: boolean(),
  interface: (Codex.Protocol.Plugin.Interface.t() | nil) | nil,
  name: String.t(),
  source: Codex.Protocol.Plugin.Source.t()
}

Functions

from_map(data)

@spec from_map(map() | keyword() | t()) :: t()

parse(value)

@spec parse(map() | keyword() | t()) ::
  {:ok, t()}
  | {:error, {:invalid_plugin_summary, CliSubprocessCore.Schema.error_detail()}}

parse!(value)

@spec parse!(map() | keyword() | t()) :: t()

schema()

@spec schema() :: Zoi.schema()

to_map(value)

@spec to_map(t()) :: map()