View Source DSL: AshJsonApi.Domain

The entrypoint for adding JSON:API behavior to an Ash domain

json_api

Global configuration for JSON:API

json_api do
  prefix "/json_api"
  log_errors? true
end

Name	Type	Default	Docs
`router`	`atom`		The router that you created for this Domain. Use by test helpers to send requests
`show_raised_errors?`	`boolean`	`false`	For security purposes, if an error is raised then Ash simply shows a generic error. If you want to show those errors, set this to true.
`prefix`	`String.t`		The route prefix at which you are serving the JSON:API
`serve_schema?`	`boolean`	`false`	Whether or not create a /schema route that serves the JSON schema of your API
`authorize?`	`boolean`	`true`	Whether or not to perform authorization on requests.
`log_errors?`	`boolean`	`true`	Whether or not to log any errors produced
`include_nil_values?`	`boolean`	`true`	Whether or not to include properties for values that are nil in the JSON output

OpenAPI configurations

json_api do
  ...
  open_api do
    tag "Users"
    group_by :api
  end
end

Name	Type	Default	Docs
`tag`	`String.t`		Tag to be used when used by :group_by
`group_by`	`:domain \| :resource`	`:resource`	Group by :domain or :resource