AmpSdk.Types.PermissionRule (AmpSdk v0.6.0)

Copy Markdown View Source

Structured representation of a permission rule returned by AmpSdk.permissions_list/1.

Summary

Types

t()

Functions

parse(rule)
parse!(rule)
schema()
to_map(rule)

Types

t()

@type t() :: %AmpSdk.Types.PermissionRule{
  action: String.t(),
  context: String.t() | nil,
  extra: map(),
  matches: map() | nil,
  to: String.t() | nil,
  tool: String.t()
}

Functions

parse(rule)

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

parse!(rule)

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

schema()

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

to_map(rule)

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