Jido.Action.Catalog.Query (Jido Action v2.3.0)

Query value for filtering and searching an action catalog.

Summary

Types

t()

Functions

new(query)

Builds a catalog query.

new!(attrs)

Same as new/1, but raises on error.

schema()

Returns the Zoi schema used to validate catalog queries.

Types

t()

@type t() :: %Jido.Action.Catalog.Query{
  capabilities: [binary()],
  filters: map(),
  limit: integer(),
  metadata: map(),
  namespace: nil | binary(),
  tags: [binary()],
  text: nil | binary(),
  visibility: [:public | :internal | :hidden]
}

Functions

new(query)

@spec new(map() | keyword() | String.t() | t()) ::
  {:ok, t()} | {:error, Exception.t()}

Builds a catalog query.

new!(attrs)

@spec new!(map() | keyword() | String.t() | t()) :: t() | no_return()

Same as new/1, but raises on error.

schema()

@spec schema() :: term()

Returns the Zoi schema used to validate catalog queries.