Skip to content

Commit ffa5d39

Browse files
committed
ci: Generate docs
1 parent 5a22532 commit ffa5d39

5 files changed

Lines changed: 15 additions & 130 deletions

File tree

docs/api/acs/credentials/README.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -78,26 +78,12 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
7878
<details>
7979
<summary>Child Properties</summary>
8080

81-
<ul>
82-
<li>
8381
<strong><code>auto_join</code></strong> <i>Boolean</i>
84-
</li>
85-
<li>
8682
<strong><code>door_names</code></strong> <i>List</i> <i>of Strings</i>
87-
</li>
88-
<li>
8983
<strong><code>endpoint_id</code></strong> <i>String</i>
90-
</li>
91-
<li>
9284
<strong><code>key_id</code></strong> <i>String</i>
93-
</li>
94-
<li>
9585
<strong><code>key_issuing_request_id</code></strong> <i>String</i>
96-
</li>
97-
<li>
9886
<strong><code>override_guest_acs_entrance_ids</code></strong> <i>List</i> <i>of Strings</i>
99-
</li>
100-
</ul>
10187
</details>
10288

10389
---
@@ -282,38 +268,20 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
282268
<details>
283269
<summary>Child Properties</summary>
284270

285-
<ul>
286-
<li>
287271
<strong><code>auto_join</code></strong> <i>Boolean</i>
288-
</li>
289-
<li>
290272
<strong><code>card_function_type</code></strong> <i>Enum</i>
291273
<details>
292274
<summary>Enum values:</summary>
293275

294276
- <code>guest`</code>
295277
- <code>staff`</code>
296278
</details>
297-
</li>
298-
<li>
299279
<strong><code>card_id</code></strong> <i>String</i>
300-
</li>
301-
<li>
302280
<strong><code>common_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
303-
</li>
304-
<li>
305281
<strong><code>credential_id</code></strong> <i>String</i>
306-
</li>
307-
<li>
308282
<strong><code>guest_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
309-
</li>
310-
<li>
311283
<strong><code>is_valid</code></strong> <i>Boolean</i>
312-
</li>
313-
<li>
314284
<strong><code>joiner_acs_credential_ids</code></strong> <i>List</i> <i>of UUIDs</i>
315-
</li>
316-
</ul>
317285
</details>
318286

319287
---

docs/api/acs/entrances/README.md

Lines changed: 0 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,8 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
4343
<details>
4444
<summary>Child Properties</summary>
4545

46-
<ul>
47-
<li>
4846
<strong><code>door_name</code></strong> <i>String</i>
49-
</li>
50-
<li>
5147
<strong><code>door_number</code></strong> <i>Number</i>
52-
</li>
53-
<li>
5448
<strong><code>door_type</code></strong> <i>Enum</i>
5549
<details>
5650
<summary>Enum values:</summary>
@@ -60,14 +54,8 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
6054
- <code>GuestDoor`</code>
6155
- <code>Elevator`</code>
6256
</details>
63-
</li>
64-
<li>
6557
<strong><code>pms_id</code></strong> <i>String</i>
66-
</li>
67-
<li>
6858
<strong><code>stand_open</code></strong> <i>Boolean</i>
69-
</li>
70-
</ul>
7159
</details>
7260

7361
---
@@ -99,11 +87,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
9987
<details>
10088
<summary>Child Properties</summary>
10189

102-
<ul>
103-
<li>
10490
<strong><code>access_point_name</code></strong> <i>String</i>
105-
</li>
106-
</ul>
10791
</details>
10892

10993
---
@@ -137,20 +121,10 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
137121
<details>
138122
<summary>Child Properties</summary>
139123

140-
<ul>
141-
<li>
142124
<strong><code>accessibility_type</code></strong> <i>String</i>
143-
</li>
144-
<li>
145125
<strong><code>door_name</code></strong> <i>String</i>
146-
</li>
147-
<li>
148126
<strong><code>door_type</code></strong> <i>String</i>
149-
</li>
150-
<li>
151127
<strong><code>is_connected</code></strong> <i>Boolean</i>
152-
</li>
153-
</ul>
154128
</details>
155129

156130
---
@@ -164,32 +138,14 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
164138
<details>
165139
<summary>Child Properties</summary>
166140

167-
<ul>
168-
<li>
169141
<strong><code>battery_level</code></strong> <i>String</i>
170-
</li>
171-
<li>
172142
<strong><code>door_name</code></strong> <i>String</i>
173-
</li>
174-
<li>
175143
<strong><code>intrusion_alarm</code></strong> <i>Boolean</i>
176-
</li>
177-
<li>
178144
<strong><code>left_open_alarm</code></strong> <i>Boolean</i>
179-
</li>
180-
<li>
181145
<strong><code>lock_type</code></strong> <i>String</i>
182-
</li>
183-
<li>
184146
<strong><code>locked_state</code></strong> <i>String</i>
185-
</li>
186-
<li>
187147
<strong><code>online</code></strong> <i>Boolean</i>
188-
</li>
189-
<li>
190148
<strong><code>privacy_mode</code></strong> <i>Boolean</i>
191-
</li>
192-
</ul>
193149
</details>
194150

195151
---
@@ -203,17 +159,9 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
203159
<details>
204160
<summary>Child Properties</summary>
205161

206-
<ul>
207-
<li>
208162
<strong><code>door_description</code></strong> <i>String</i>
209-
</li>
210-
<li>
211163
<strong><code>door_name</code></strong> <i>String</i>
212-
</li>
213-
<li>
214164
<strong><code>ext_door_id</code></strong> <i>String</i>
215-
</li>
216-
</ul>
217165
</details>
218166

219167
---
@@ -227,8 +175,6 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
227175
<details>
228176
<summary>Child Properties</summary>
229177

230-
<ul>
231-
<li>
232178
<strong><code>door_category</code></strong> <i>Enum</i>
233179
<details>
234180
<summary>Enum values:</summary>
@@ -239,11 +185,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
239185
- <code>common`</code>
240186
- <code>common (PMS)`</code>
241187
</details>
242-
</li>
243-
<li>
244188
<strong><code>door_name</code></strong> <i>String</i>
245-
</li>
246-
<li>
247189
<strong><code>profiles</code></strong> <i>List</i> <i>of Objects</i>
248190

249191
- <strong><code>visionline_door_profile_id</code></strong> <i>String</i>
@@ -258,8 +200,6 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
258200
- <code>touch`</code>
259201
</details>
260202

261-
</li>
262-
</ul>
263203
</details>
264204

265205
---

docs/api/acs/systems/README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -421,13 +421,9 @@ Indicates whether the `acs_system` is a credential manager.
421421
<details>
422422
<summary>Child Properties</summary>
423423

424-
<ul>
425-
<li>
426424
<strong><code>time_zone</code></strong> <i>String</i>
427425

428426
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
429-
</li>
430-
</ul>
431427
</details>
432428

433429
---
@@ -488,23 +484,15 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
488484
<details>
489485
<summary>Child Properties</summary>
490486

491-
<ul>
492-
<li>
493487
<strong><code>lan_address</code></strong> <i>String</i>
494488

495489
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
496-
</li>
497-
<li>
498490
<strong><code>mobile_access_uuid</code></strong> <i>String</i>
499491

500492
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
501-
</li>
502-
<li>
503493
<strong><code>system_id</code></strong> <i>String</i>
504494

505495
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
506-
</li>
507-
</ul>
508496
</details>
509497

510498
---

docs/api/acs/users/README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,12 @@ For details about how to configure `acs_user`s in your access control system, se
2727
<details>
2828
<summary>Child Properties</summary>
2929

30-
<ul>
31-
<li>
3230
<strong><code>ends_at</code></strong> <i>Datetime</i>
3331

3432
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.
35-
</li>
36-
<li>
3733
<strong><code>starts_at</code></strong> <i>Datetime</i>
3834

3935
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.
40-
</li>
41-
</ul>
4236
</details>
4337

4438
---

docs/api/connected_accounts/README.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -316,26 +316,21 @@ User identifier associated with the connected account.
316316
<details>
317317
<summary>Child Properties</summary>
318318

319-
- <strong><code>api_url</code></strong> <i>String</i>
320-
321-
API URL for the user identifier associated with the connected account.
322-
323-
- <strong><code>email</code></strong> <i>String</i>
324-
325-
Email address of the user identifier associated with the connected account.
326-
327-
- <strong><code>exclusive</code></strong> <i>Boolean</i>
328-
329-
Indicates whether the user identifier associated with the connected account is exclusive.
330-
331-
- <strong><code>phone</code></strong> <i>String</i>
332-
333-
Phone number of the user identifier associated with the connected account.
334-
335-
- <strong><code>username</code></strong> <i>String</i>
336-
337-
Username of the user identifier associated with the connected account.
338-
319+
<strong><code>api_url</code></strong> <i>String</i>
320+
321+
API URL for the user identifier associated with the connected account.
322+
<strong><code>email</code></strong> <i>String</i>
323+
324+
Email address of the user identifier associated with the connected account.
325+
<strong><code>exclusive</code></strong> <i>Boolean</i>
326+
327+
Indicates whether the user identifier associated with the connected account is exclusive.
328+
<strong><code>phone</code></strong> <i>String</i>
329+
330+
Phone number of the user identifier associated with the connected account.
331+
<strong><code>username</code></strong> <i>String</i>
332+
333+
Username of the user identifier associated with the connected account.
339334
</details>
340335

341336
---

0 commit comments

Comments
 (0)