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

Copy Markdown View Source

Plugin app metadata returned by plugin/read and plugin/install.

Summary

Types

t()

Functions

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

Types

t()

@type t() :: %Codex.Protocol.Plugin.AppSummary{
  description: (String.t() | nil) | nil,
  extra: map(),
  id: String.t(),
  install_url: (String.t() | nil) | nil,
  name: String.t(),
  needs_auth: boolean()
}

Functions

from_map(data)

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

parse(value)

@spec parse(map() | keyword() | t()) ::
  {:ok, t()}
  | {:error,
     {:invalid_plugin_app_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()