From 79bc19944c19eafcb7aad6a352162f94c8b2af27 Mon Sep 17 00:00:00 2001 From: James Harton Date: Mon, 11 Mar 2024 16:04:05 +1300 Subject: [PATCH] docs: Update DSL documentation. --- documentation/dsls/DSL:-AshAuthentication.TokenResource.md | 2 +- documentation/dsls/DSL:-AshAuthentication.UserIdentity.md | 2 +- documentation/dsls/DSL:-AshAuthentication.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/dsls/DSL:-AshAuthentication.TokenResource.md b/documentation/dsls/DSL:-AshAuthentication.TokenResource.md index 0e2b1ef4..412092c7 100644 --- a/documentation/dsls/DSL:-AshAuthentication.TokenResource.md +++ b/documentation/dsls/DSL:-AshAuthentication.TokenResource.md @@ -70,7 +70,7 @@ Configuration options for this token resource | Name | Type | Default | Docs | |------|------|---------|------| -| [`api`](#token-api){: #token-api .spark-required} | `module` | | The Ash API to use to access this resource. | +| [`api`](#token-api){: #token-api } | `module` | | The Ash API to use to access this resource. | | [`expunge_expired_action_name`](#token-expunge_expired_action_name){: #token-expunge_expired_action_name } | `atom` | `:expunge_expired` | The name of the action used to remove expired tokens. | | [`read_expired_action_name`](#token-read_expired_action_name){: #token-read_expired_action_name } | `atom` | `:read_expired` | The name of the action use to find all expired tokens. | | [`expunge_interval`](#token-expunge_interval){: #token-expunge_interval } | `pos_integer` | `12` | How often to scan this resource for records which have expired, and thus can be removed. | diff --git a/documentation/dsls/DSL:-AshAuthentication.UserIdentity.md b/documentation/dsls/DSL:-AshAuthentication.UserIdentity.md index a48e6d23..b4b16fcb 100644 --- a/documentation/dsls/DSL:-AshAuthentication.UserIdentity.md +++ b/documentation/dsls/DSL:-AshAuthentication.UserIdentity.md @@ -59,8 +59,8 @@ Configure identity options for this resource | Name | Type | Default | Docs | |------|------|---------|------| -| [`api`](#user_identity-api){: #user_identity-api .spark-required} | `module` | | The Ash API to use to access this resource. | | [`user_resource`](#user_identity-user_resource){: #user_identity-user_resource .spark-required} | `module` | | The user resource to which these identities belong. | +| [`api`](#user_identity-api){: #user_identity-api } | `module` | | The Ash API to use to access this resource. | | [`uid_attribute_name`](#user_identity-uid_attribute_name){: #user_identity-uid_attribute_name } | `atom` | `:uid` | The name of the `uid` attribute on this resource. | | [`strategy_attribute_name`](#user_identity-strategy_attribute_name){: #user_identity-strategy_attribute_name } | `atom` | `:strategy` | The name of the `strategy` attribute on this resource. | | [`user_id_attribute_name`](#user_identity-user_id_attribute_name){: #user_identity-user_id_attribute_name } | `atom` | `:user_id` | The name of the `user_id` attribute on this resource. | diff --git a/documentation/dsls/DSL:-AshAuthentication.md b/documentation/dsls/DSL:-AshAuthentication.md index 8c0ce241..f5b6c2c3 100644 --- a/documentation/dsls/DSL:-AshAuthentication.md +++ b/documentation/dsls/DSL:-AshAuthentication.md @@ -100,8 +100,8 @@ Configure authentication for this resource | Name | Type | Default | Docs | |------|------|---------|------| -| [`api`](#authentication-api){: #authentication-api .spark-required} | `module` | | The name of the Ash API to use to access this resource when doing anything authenticaiton related. | | [`subject_name`](#authentication-subject_name){: #authentication-subject_name } | `atom` | | The subject name is used anywhere that a short version of your resource name is needed. Must be unique system-wide and will be inferred from the resource name by default (ie `MyApp.Accounts.User` -> `user`). | +| [`api`](#authentication-api){: #authentication-api } | `module` | | The name of the Ash API to use to access this resource when doing anything authenticaiton related. | | [`get_by_subject_action_name`](#authentication-get_by_subject_action_name){: #authentication-get_by_subject_action_name } | `atom` | `:get_by_subject` | The name of the read action used to retrieve records. If the action doesn't exist, one will be generated for you. | | [`select_for_senders`](#authentication-select_for_senders){: #authentication-select_for_senders } | `list(atom)` | | A list of fields that we will ensure are selected whenever a sender will be invoked. Defaults to `[:email]` if there is an `:email` attribute on the resource, and `[]` otherwise. |