ash/documentation/dsls/DSL:-Ash.Registry.md
Zach Daniel 2233a33523 improvement: support tenancy on manual actions
docs: update cheat shets
fix: honor tenant option on aggregates

closes #805
2023-12-16 10:33:10 -05:00

75 lines
1.2 KiB
Markdown

<!--
This file was generated by Spark. Do not edit it by hand.
-->
# DSL: Ash.Registry.Dsl
A small DSL for declaring an `Ash.Registry`. Not generally necessary any longer.
`Ash.Registry` can be used generically, but the main way it is used in Ash is to provide a compile-time registry for an Ash Api.
## entries
List the entries present in this registry
### Nested DSLs
* [entry](#entries-entry)
### Examples
```
entries do
entry MyApp.User
entry MyApp.Post
entry MyApp.Comment
end
```
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`warn_on_empty?`](#entries-warn_on_empty?){: #entries-warn_on_empty? } | `boolean` | `true` | Set to `false` to ignore warnings about an empty registry |
## entries.entry
```elixir
entry entry
```
A reference to an ash module (typically a resource)
### Examples
```
entry MyApp.User
```
### Arguments
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`entry`](#entries-entry-entry){: #entries-entry-entry .spark-required} | `atom` | | The referenced module |
### Introspection
Target: `Ash.Registry.Entry`
<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>