AshBackendDrivenOptimisticUi.RuleSet (AshBackendDrivenOptimisticUi v0.1.0)

Copy Markdown View Source

A ready Ash resource that serves the rules.

Add it to a domain and expose its :rules action with your API layer, like any other action:

resources do
  resource AshBackendDrivenOptimisticUi.RuleSet
end

The action returns AshBackendDrivenOptimisticUi.Registry.rules/0. The resource holds no data and is never counted as a rule resource.

Summary

Functions

Validates that the keys in the provided input are valid for at least one action on the resource.

Same as input/1, except restricts the keys to values accepted by the action provided.

Functions

default_short_name()

input(opts)

@spec input(values :: map() | Keyword.t()) :: map() | no_return()

Validates that the keys in the provided input are valid for at least one action on the resource.

Raises a KeyError error at compile time if not. This exists because generally a struct should only ever be created by Ash as a result of a successful action. You should not be creating records manually in code, e.g %MyResource{value: 1, value: 2}. Generally that is fine, but often with embedded resources it is nice to be able to validate the keys that are being provided, e.g

Resource
|> Ash.Changeset.for_create(:create, %{embedded: EmbeddedResource.input(foo: 1, bar: 2)})
|> Ash.create()

input(opts, action)

@spec input(values :: map() | Keyword.t(), action :: atom()) :: map() | no_return()

Same as input/1, except restricts the keys to values accepted by the action provided.