mirror of
https://github.com/ash-project/ash.git
synced 2024-09-20 13:33:20 +12:00
docs: fix docs for check/4
This commit is contained in:
parent
04744f395f
commit
8f2c74da74
1 changed files with 2 additions and 5 deletions
|
@ -38,13 +38,10 @@ defmodule Ash.Policy.Check do
|
|||
@doc """
|
||||
An optional callback, hat allows the check to work with policies set to `access_type :runtime`
|
||||
|
||||
Takes a list of records, and returns `{:ok, true}` if they are all authorized, or `{:ok, list}` containing the list
|
||||
of records that are authorized. You can also just return the whole list, `{:ok, true}` is just a shortcut.
|
||||
|
||||
Can also return `{:error, error}` if something goes wrong
|
||||
Takes a list of records, and returns the subset of authorized records.
|
||||
"""
|
||||
@callback check(struct(), list(Ash.Resource.record()), map, options) ::
|
||||
{:ok, list(Ash.Resource.record()) | boolean} | {:error, Ash.Error.t()}
|
||||
list(Ash.Resource.record())
|
||||
@doc "Describe the check in human readable format, given the options"
|
||||
@callback describe(options()) :: String.t()
|
||||
|
||||
|
|
Loading…
Reference in a new issue