Skip to content

Commit

Permalink
Format child prop names as code and fix details line spacing (#469)
Browse files Browse the repository at this point in the history
  • Loading branch information
DebbieAtSeam authored Dec 19, 2024
1 parent 94c54a2 commit 6a4942e
Show file tree
Hide file tree
Showing 5 changed files with 205 additions and 41 deletions.
48 changes: 40 additions & 8 deletions docs/api/acs/credentials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,30 +212,62 @@ Format: `Object`
Visionline-specific metadata for the credential.

<details>
<summary>auto_join <code>boolean</code></summary>

<summary><code>auto_join</code> Format: <code>boolean</code></summary>


</details>

<details>
<summary>card_function_type <code>enum</code></summary>

<summary><code>card_function_type</code> Format: <code>enum</code></summary>


</details>

<details>
<summary>card_id <code>string</code></summary>

<summary><code>card_id</code> Format: <code>string</code></summary>


</details>

<details>
<summary>common_acs_entrance_ids <code>list</code></summary>

<summary><code>common_acs_entrance_ids</code> Format: <code>list</code></summary>


</details>

<details>
<summary>credential_id <code>string</code></summary>

<summary><code>credential_id</code> Format: <code>string</code></summary>


</details>

<details>
<summary>guest_acs_entrance_ids <code>list</code></summary>

<summary><code>guest_acs_entrance_ids</code> Format: <code>list</code></summary>


</details>

<details>
<summary>is_valid <code>boolean</code></summary>

<summary><code>is_valid</code> Format: <code>boolean</code></summary>


</details>

<details>
<summary>joiner_acs_credential_ids <code>list</code></summary>

<summary><code>joiner_acs_credential_ids</code> Format: <code>list</code></summary>


</details>


---

### `warnings`
Expand Down
156 changes: 130 additions & 26 deletions docs/api/acs/entrances/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,41 @@ ID of the access control system that contains the entrance.
Format: `Object`

<details>
<summary>door_name <code>string</code></summary>

<summary><code>door_name</code> Format: <code>string</code></summary>


</details>

<details>
<summary>door_number <code>number</code></summary>

<summary><code>door_number</code> Format: <code>number</code></summary>


</details>

<details>
<summary>door_type <code>enum</code></summary>

<summary><code>door_type</code> Format: <code>enum</code></summary>


</details>

<details>
<summary>pms_id <code>string</code></summary>

<summary><code>pms_id</code> Format: <code>string</code></summary>


</details>

<details>
<summary>stand_open <code>boolean</code></summary>

<summary><code>stand_open</code> Format: <code>boolean</code></summary>


</details>


---

### `created_at`
Expand All @@ -67,15 +87,27 @@ Display name for the entrance.
Format: `Object`

<details>
<summary>access_point_name <code>string</code></summary>

<summary><code>access_point_name</code> Format: <code>string</code></summary>


</details>

<details>
<summary>common_area_number <code>number</code></summary>

<summary><code>common_area_number</code> Format: <code>number</code></summary>


</details>

<details>
<summary>inner_access_points_names <code>list</code></summary>

<summary><code>inner_access_points_names</code> Format: <code>list</code></summary>


</details>


---

### `errors`
Expand All @@ -90,81 +122,153 @@ Format: `List`
Format: `Object`

<details>
<summary>accessibility_type <code>string</code></summary>

<summary><code>accessibility_type</code> Format: <code>string</code></summary>


</details>

<details>
<summary>door_name <code>string</code></summary>

<summary><code>door_name</code> Format: <code>string</code></summary>


</details>

<details>
<summary>door_type <code>string</code></summary>

<summary><code>door_type</code> Format: <code>string</code></summary>


</details>

<details>
<summary>is_connected <code>boolean</code></summary>

<summary><code>is_connected</code> Format: <code>boolean</code></summary>


</details>


---

### `salto_ks_metadata`

Format: `Object`

<details>
<summary>battery_level <code>string</code></summary>

<summary><code>battery_level</code> Format: <code>string</code></summary>


</details>

<details>
<summary>door_name <code>string</code></summary>

<summary><code>door_name</code> Format: <code>string</code></summary>


</details>

<details>
<summary>intrusion_alarm <code>boolean</code></summary>

<summary><code>intrusion_alarm</code> Format: <code>boolean</code></summary>


</details>

<details>
<summary>left_open_alarm <code>boolean</code></summary>

<summary><code>left_open_alarm</code> Format: <code>boolean</code></summary>


</details>

<details>
<summary>lock_type <code>string</code></summary>

<summary><code>lock_type</code> Format: <code>string</code></summary>


</details>

<details>
<summary>locked_state <code>string</code></summary>

<summary><code>locked_state</code> Format: <code>string</code></summary>


</details>

<details>
<summary>online <code>boolean</code></summary>

<summary><code>online</code> Format: <code>boolean</code></summary>


</details>

<details>
<summary>privacy_mode <code>boolean</code></summary>

<summary><code>privacy_mode</code> Format: <code>boolean</code></summary>


</details>


---

### `salto_space_metadata`

Format: `Object`

<details>
<summary>door_description <code>string</code></summary>

<summary><code>door_description</code> Format: <code>string</code></summary>


</details>

<details>
<summary>door_name <code>string</code></summary>

<summary><code>door_name</code> Format: <code>string</code></summary>


</details>

<details>
<summary>ext_door_id <code>string</code></summary>

<summary><code>ext_door_id</code> Format: <code>string</code></summary>


</details>


---

### `visionline_metadata`

Format: `Object`

<details>
<summary>door_category <code>enum</code></summary>

<summary><code>door_category</code> Format: <code>enum</code></summary>


</details>

<details>
<summary>door_name <code>string</code></summary>

<summary><code>door_name</code> Format: <code>string</code></summary>


</details>

<details>
<summary>profiles <code>list</code></summary>

<summary><code>profiles</code> Format: <code>list</code></summary>


</details>


---

## Endpoints
Expand Down
24 changes: 20 additions & 4 deletions docs/api/acs/systems/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,14 @@ Indicates if the `acs_system` is a credential manager.
Format: `Object`

<details>
<summary>time_zone <code>string</code></summary>

<summary><code>time_zone</code> Format: <code>string</code></summary>

Time zone in which the `acs_system` is located.

</details>


---

### `name`
Expand Down Expand Up @@ -219,18 +223,30 @@ Format: `String`
Format: `Object`

<details>
<summary>lan_address <code>string</code></summary>

<summary><code>lan_address</code> Format: <code>string</code></summary>

IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.

</details>

<details>
<summary>mobile_access_uuid <code>string</code></summary>

<summary><code>mobile_access_uuid</code> Format: <code>string</code></summary>

Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.

</details>

<details>
<summary>system_id <code>string</code></summary>

<summary><code>system_id</code> Format: <code>string</code></summary>

Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.

</details>


---

### `warnings`
Expand Down
12 changes: 10 additions & 2 deletions docs/api/acs/users/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,22 @@ Format: `Object`
`starts_at` and `ends_at` timestamps for the `acs_user`'s access.

<details>
<summary>ends_at <code>datetime</code></summary>

<summary><code>ends_at</code> Format: <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>

<summary><code>starts_at</code> Format: <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>


---

### `acs_system_id`
Expand Down
Loading

0 comments on commit 6a4942e

Please sign in to comment.