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

Plugin presentation metadata returned on plugin summary/detail responses.

Summary

Types

t()

Functions

from_map(data)

parse(value)

parse!(value)

schema()

to_map(value)

Types

t()

@type t() :: %Codex.Protocol.Plugin.Interface{
  brand_color: (String.t() | nil) | nil,
  capabilities: [String.t()],
  category: (String.t() | nil) | nil,
  composer_icon: (String.t() | nil) | nil,
  default_prompt: ([String.t()] | nil) | nil,
  developer_name: (String.t() | nil) | nil,
  display_name: (String.t() | nil) | nil,
  extra: map(),
  logo: (String.t() | nil) | nil,
  long_description: (String.t() | nil) | nil,
  privacy_policy_url: (String.t() | nil) | nil,
  screenshots: [String.t()],
  short_description: (String.t() | nil) | nil,
  terms_of_service_url: (String.t() | nil) | nil,
  website_url: (String.t() | nil) | nil
}

Functions

from_map(data)

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

parse(value)

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