ash-project/ash
1
0
Fork 0
mirror of https://github.com/ash-project/ash.git synced 2024-09-20 13:33:20 +12:00
Code Issues Projects Releases Packages Wiki Activity

docs: update description of allow_nil_input

Browse source
This commit is contained in:
Zach Daniel 2021-09-08 22:52:18 -04:00
parent d200d354e7
commit c7cfa878e7
1 changed files with 2 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lib/ash/resource/actions/create.ex
View file

@ -35,14 +35,8 @@ defmodule Ash.Resource.Actions.Create do
allow_nil_input: [
type: {:list, :atom},
doc: """
A list of attributes that would normally be required, but should not be for this action.
This exists because extensions like ash_graphql and ash_json_api will add non-null validations to their input for any attribute
that is accepted by an action that has `allow_nil?: false`. This tells those extensions that some `change` on the resource might
set that attribute, and so they should not require it at the API layer.
Ash core doesn't actually use the values in this list, because it does its `nil` validation *after* running all resource
changes. If the value is still `nil` by the time Ash would submit to the data layer, then an error is returned.
A list of attributes that would normally be required, but should not be for this action. They will still be validated just before
the record is created, but this allows for setting required attributes in your changes under the hood.
"""
]
]