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

Copy Markdown View Source

Plugin auth policy values returned by the app-server plugin APIs.

Summary

Types

t()

Functions

normalize(value)
normalize_zoi(value, opts)
parse(value)
parse!(value)
schema()
to_wire(value)

Types

t()

@type t() :: :on_install | :on_use | String.t()

Functions

normalize(value)

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

normalize_zoi(value, opts)

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

parse(value)

@spec parse(term()) ::
  {:ok, t()}
  | {:error,
     {:invalid_plugin_auth_policy, CliSubprocessCore.Schema.error_detail()}}

parse!(value)

@spec parse!(term()) :: t()

schema()

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

to_wire(value)

@spec to_wire(t()) :: String.t()