View Source Ash.Api.Dsl (ash v1.53.3)
A small DSL for declaring APIs
Apis are the entrypoints for working with your resources.
Apis may optionally include a list of resources, in which case they can be
used as an
Ash.Registry in various places. This is for backwards compatibility,
but if at all possible you should define an
Ash.Registry if you are using an extension
that requires a list of resources. For example, most extensions look for two application
environment variables called
:ash_registries to find any potential registries
List the resources present in this API
resources do registry MyApp.Registry end
:allow- Support a dynamic resource list by providing a callback that checks whether or not the resource should be allowed.
:allow_unregistered?- By default, an api will only work with resources that are explicitly included in the provided registry. In order to separate your application into multiple domains, you may wish to "mix and match" your resources across contexts. Specifying this option allows you to refer to resources in different apis in your resources, and allows providing any resource to api actions (to facilitate that requirement).
Be sure to remove the Ash.Registry.ResourceValidations extension from your registry as well. The default value is
:registry- Allows declaring that only the modules in a certain registry should be allowed to work with this Api.
This option is ignored if any explicit resources are included in the api, so everything is either in the registry or in the api. See the docs on
Ash.Registryfor what the registry is used for.
To optimize for compile times, you can place the connection from the api to the registry in application configuration.
To accomplish this:
- Configure an
otp_appwhen using your api, e.g
use Ash.Api, otp_app: :my_app
- Add application config to set up the connection
config :my_app, MyApp.Api, resources: [ registry: MyApp.Api.Registry ]
Options for how requests are executed using this Api
execution do timeout :timer.seconds(30) end
:timeout- The default timeout to use for requests using this API. The default value is
Options for how requests are authorized using this Api
authorization do authorize :by_default require_actor? true end
:require_actor?- Requires that an actor has been supplied. The default value is
:authorize- When to run authorization for a given request. The default value is