View Source DSL: Ash.Api.Dsl

api

General Api configuration

api do
  description """
  Resources related to the flux capacitor.
  """
end

Name	Type	Default	Docs
`description`	`String.t`		A description for the api.

List the resources present in this API

resources do
  resource MyApp.Tweet
  resource MyApp.Comment
end

Name	Type	Default	Docs
`allow`	`mfa`		Support a dynamic resource list by providing a callback that checks whether or not the resource should be allowed.
`allow_unregistered?`	`boolean`	`false`	Whether the Api will support only registered entries or not.
`registry`	`module`		Configure a registry that contains the resources. This option is generally not necessary anymore, and remains for backwards compatibility. Instead, configure resources in this block directly.

resource resource

A resource present in the API

resource Foo

Name	Type	Default	Docs
`resource`	`module`

Options for how requests are executed using this Api

execution do
  timeout :timer.seconds(30)
end

Name	Type	Default	Docs
`timeout`	`timeout`	`30000`	The default timeout to use for requests using this API. See the timeouts guide for more.
`trace_name`	`String.t`		The name to use in traces. Defaults to the last part of the module. See the monitoring guide for more

Options for how requests are authorized using this Api. See the security guide for more.

authorization do
  authorize :by_default
end

Name	Type	Default	Docs
`require_actor?`	`boolean`	`false`	Requires that an actor has been supplied.
`authorize`	`:always \| :by_default \| :when_requested`	`:when_requested`	When to run authorization for a given request.