View Source Ash.Resource.Validation behaviour (ash v2.11.8)

Represents a validation in Ash.

See Ash.Resource.Validation.Builtins for a list of builtin validations.

To write your own validation, define a module that implements the init/1 callback to validate options at compile time, and validate/2 callback to do the validation.

Then, in a resource, you can say:

validations do
  validate {MyValidation, [foo: :bar]}
end

Link to this section Summary

Types

path()

ref()

t()

Callbacks

describe(t)

init(t)

validate(t, t)

Functions

action_schema()

on(list)

opt_schema()

validation_type()

Link to this section Types

path()

@type path() :: [atom() | integer()]

ref()

@type ref() :: {module(), Keyword.t()} | module()

t()

@type t() :: %Ash.Resource.Validation{
  before_action?: term(),
  description: String.t() | nil,
  message: term(),
  module: atom(),
  on: [atom()],
  only_when_valid?: boolean(),
  opts: [atom()],
  validation: {atom(), [atom()]},
  where: [{atom(), [atom()]}]
}

Link to this section Callbacks

describe(t)

(optional)

@callback describe(Keyword.t()) :: [message: String.t(), vars: Keyword.t()]

init(t)

@callback init(Keyword.t()) :: {:ok, Keyword.t()} | {:error, String.t()}

validate(t, t)

@callback validate(Ash.Changeset.t(), Keyword.t()) :: :ok | {:error, term()}

Settings View Source Ash.Resource.Validation behaviour (ash v2.11.8)

Link to this section Summary

Types

Callbacks

Functions

Link to this section Types

path()

ref()

t()

Link to this section Callbacks

describe(t)

init(t)

validate(t, t)

Link to this section Functions

action_schema()

on(list)

opt_schema()

validation_type()

View Source Ash.Resource.Validation behaviour (ash v2.11.8)