ci: Generate docs

seamapi · Nov 1, 2024 · 9961470 · 9961470
1 parent 36f68a6
commit 9961470
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 12 deletions.
diff --git a/docs/api/_report.md b/docs/api/_report.md
@@ -41,7 +41,6 @@ Items that are intentionally undocumented are not included in this section.
 
 - `acs_credential_pool`
 - `acs_credential_provisioning_automation`
-- `acs_entrance`
 - `acs_user`
 - `event`
 - `thermostat_schedule`
@@ -317,8 +316,8 @@ These items are deprecated.
 
 ### Resource properties
 
-- `acs_access_group.access_group_type`: use external_type
-- `acs_access_group.access_group_type_display_name`: use external_type_display_name
+- `acs_access_group.access_group_type`: Use `external_type`.
+- `acs_access_group.access_group_type_display_name`: Use `external_type_display_name`.
 - `acs_system.system_type`: Use `external_type`.
 - `acs_system.system_type_display_name`: Use `external_type_display_name`.
 - `acs_user.email`: use email_address.

diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
@@ -2,18 +2,15 @@
 
 ## `acs_access_group`
 
-
-    Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
-
-    The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-
+Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
 
 ### Properties
 
 #### `access_group_type`
 
 {% hint style="warning" %}
-**Deprecated**. use external_type
+**Deprecated**. Use `external_type`.
 {% endhint %}
 
 Format: `Enum`
@@ -30,7 +27,7 @@ Possible enum values:
 #### `access_group_type_display_name`
 
 {% hint style="warning" %}
-**Deprecated**. use external_type_display_name
+**Deprecated**. Use `external_type_display_name`.
 {% endhint %}
 
 Format: `String`

diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
@@ -3,8 +3,7 @@
 ## `acs_credential`
 
 Means by which a user gains access at an entrance.
-
-      The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.
+The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.
 
 ### Properties
 

diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
@@ -2,6 +2,8 @@
 
 ## `acs_entrance`
 
+Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
 ### Properties
 
 #### `acs_entrance_id`

diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
@@ -12,9 +12,11 @@ Format: `Object`
 
 <details>
 <summary>ends_at <code>datetime</code></summary>
+Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
 </details>
 <details>
 <summary>starts_at <code>datetime</code></summary>
+Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
 </details>
 
 ---