Skip to content

Commit 876fb61

Browse files
seambotseambot
committed
ci: Generate docs
1 parent 00d1359 commit 876fb61

4 files changed

Lines changed: 202 additions & 136 deletions

File tree

‎docs/api/acs/credentials/README.md‎

Lines changed: 52 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -113,18 +113,26 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
113113
<details>
114114
<summary>Child Properties</summary>
115115

116-
- <strong><code>auto_join</code></strong> <i>Boolean</i>
117-
118-
- <strong><code>door_names</code></strong> <i>List</i> <i>of Strings</i>
119-
120-
- <strong><code>endpoint_id</code></strong> <i>String</i>
121-
122-
- <strong><code>key_id</code></strong> <i>String</i>
123-
124-
- <strong><code>key_issuing_request_id</code></strong> <i>String</i>
125-
126-
- <strong><code>override_guest_acs_entrance_ids</code></strong> <i>List</i> <i>of Strings</i>
127-
116+
<ul>
117+
<li>
118+
<strong><code>auto_join</code></strong> <i>Boolean</i>
119+
</li>
120+
<li>
121+
<strong><code>door_names</code></strong> <i>List</i> <i>of Strings</i>
122+
</li>
123+
<li>
124+
<strong><code>endpoint_id</code></strong> <i>String</i>
125+
</li>
126+
<li>
127+
<strong><code>key_id</code></strong> <i>String</i>
128+
</li>
129+
<li>
130+
<strong><code>key_issuing_request_id</code></strong> <i>String</i>
131+
</li>
132+
<li>
133+
<strong><code>override_guest_acs_entrance_ids</code></strong> <i>List</i> <i>of Strings</i>
134+
</li>
135+
</ul>
128136
</details>
129137

130138
---
@@ -307,28 +315,38 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
307315
<details>
308316
<summary>Child Properties</summary>
309317

310-
- <strong><code>auto_join</code></strong> <i>Boolean</i>
311-
312-
- <strong><code>card_function_type</code></strong> <i>Enum</i>
313-
<details>
314-
<summary>Enum values:</summary>
315-
316-
- <code>guest`</code>
317-
- <code>staff`</code>
318-
</details>
319-
320-
- <strong><code>card_id</code></strong> <i>String</i>
321-
322-
- <strong><code>common_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
323-
324-
- <strong><code>credential_id</code></strong> <i>String</i>
325-
326-
- <strong><code>guest_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
327-
328-
- <strong><code>is_valid</code></strong> <i>Boolean</i>
329-
330-
- <strong><code>joiner_acs_credential_ids</code></strong> <i>List</i> <i>of UUIDs</i>
331-
318+
<ul>
319+
<li>
320+
<strong><code>auto_join</code></strong> <i>Boolean</i>
321+
</li>
322+
<li>
323+
<strong><code>card_function_type</code></strong> <i>Enum</i>
324+
<details>
325+
<summary>Enum values:</summary>
326+
327+
- <code>guest`</code>
328+
- <code>staff`</code>
329+
</details>
330+
</li>
331+
<li>
332+
<strong><code>card_id</code></strong> <i>String</i>
333+
</li>
334+
<li>
335+
<strong><code>common_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
336+
</li>
337+
<li>
338+
<strong><code>credential_id</code></strong> <i>String</i>
339+
</li>
340+
<li>
341+
<strong><code>guest_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
342+
</li>
343+
<li>
344+
<strong><code>is_valid</code></strong> <i>Boolean</i>
345+
</li>
346+
<li>
347+
<strong><code>joiner_acs_credential_ids</code></strong> <i>List</i> <i>of UUIDs</i>
348+
</li>
349+
</ul>
332350
</details>
333351

334352
---

‎docs/api/acs/entrances/README.md‎

Lines changed: 114 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -63,24 +63,31 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
6363
<details>
6464
<summary>Child Properties</summary>
6565

66-
- <strong><code>door_name</code></strong> <i>String</i>
67-
68-
- <strong><code>door_number</code></strong> <i>Number</i>
69-
70-
- <strong><code>door_type</code></strong> <i>Enum</i>
71-
<details>
72-
<summary>Enum values:</summary>
73-
74-
- <code>CommonDoor`</code>
75-
- <code>EntranceDoor`</code>
76-
- <code>GuestDoor`</code>
77-
- <code>Elevator`</code>
78-
</details>
79-
80-
- <strong><code>pms_id</code></strong> <i>String</i>
81-
82-
- <strong><code>stand_open</code></strong> <i>Boolean</i>
83-
66+
<ul>
67+
<li>
68+
<strong><code>door_name</code></strong> <i>String</i>
69+
</li>
70+
<li>
71+
<strong><code>door_number</code></strong> <i>Number</i>
72+
</li>
73+
<li>
74+
<strong><code>door_type</code></strong> <i>Enum</i>
75+
<details>
76+
<summary>Enum values:</summary>
77+
78+
- <code>CommonDoor`</code>
79+
- <code>EntranceDoor`</code>
80+
- <code>GuestDoor`</code>
81+
- <code>Elevator`</code>
82+
</details>
83+
</li>
84+
<li>
85+
<strong><code>pms_id</code></strong> <i>String</i>
86+
</li>
87+
<li>
88+
<strong><code>stand_open</code></strong> <i>Boolean</i>
89+
</li>
90+
</ul>
8491
</details>
8592

8693
---
@@ -112,8 +119,11 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
112119
<details>
113120
<summary>Child Properties</summary>
114121

115-
- <strong><code>access_point_name</code></strong> <i>String</i>
116-
122+
<ul>
123+
<li>
124+
<strong><code>access_point_name</code></strong> <i>String</i>
125+
</li>
126+
</ul>
117127
</details>
118128

119129
---
@@ -145,14 +155,20 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
145155
<details>
146156
<summary>Child Properties</summary>
147157

148-
- <strong><code>accessibility_type</code></strong> <i>String</i>
149-
150-
- <strong><code>door_name</code></strong> <i>String</i>
151-
152-
- <strong><code>door_type</code></strong> <i>String</i>
153-
154-
- <strong><code>is_connected</code></strong> <i>Boolean</i>
155-
158+
<ul>
159+
<li>
160+
<strong><code>accessibility_type</code></strong> <i>String</i>
161+
</li>
162+
<li>
163+
<strong><code>door_name</code></strong> <i>String</i>
164+
</li>
165+
<li>
166+
<strong><code>door_type</code></strong> <i>String</i>
167+
</li>
168+
<li>
169+
<strong><code>is_connected</code></strong> <i>Boolean</i>
170+
</li>
171+
</ul>
156172
</details>
157173

158174
---
@@ -166,22 +182,32 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
166182
<details>
167183
<summary>Child Properties</summary>
168184

169-
- <strong><code>battery_level</code></strong> <i>String</i>
170-
171-
- <strong><code>door_name</code></strong> <i>String</i>
172-
173-
- <strong><code>intrusion_alarm</code></strong> <i>Boolean</i>
174-
175-
- <strong><code>left_open_alarm</code></strong> <i>Boolean</i>
176-
177-
- <strong><code>lock_type</code></strong> <i>String</i>
178-
179-
- <strong><code>locked_state</code></strong> <i>String</i>
180-
181-
- <strong><code>online</code></strong> <i>Boolean</i>
182-
183-
- <strong><code>privacy_mode</code></strong> <i>Boolean</i>
184-
185+
<ul>
186+
<li>
187+
<strong><code>battery_level</code></strong> <i>String</i>
188+
</li>
189+
<li>
190+
<strong><code>door_name</code></strong> <i>String</i>
191+
</li>
192+
<li>
193+
<strong><code>intrusion_alarm</code></strong> <i>Boolean</i>
194+
</li>
195+
<li>
196+
<strong><code>left_open_alarm</code></strong> <i>Boolean</i>
197+
</li>
198+
<li>
199+
<strong><code>lock_type</code></strong> <i>String</i>
200+
</li>
201+
<li>
202+
<strong><code>locked_state</code></strong> <i>String</i>
203+
</li>
204+
<li>
205+
<strong><code>online</code></strong> <i>Boolean</i>
206+
</li>
207+
<li>
208+
<strong><code>privacy_mode</code></strong> <i>Boolean</i>
209+
</li>
210+
</ul>
185211
</details>
186212

187213
---
@@ -195,12 +221,17 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
195221
<details>
196222
<summary>Child Properties</summary>
197223

198-
- <strong><code>door_description</code></strong> <i>String</i>
199-
200-
- <strong><code>door_name</code></strong> <i>String</i>
201-
202-
- <strong><code>ext_door_id</code></strong> <i>String</i>
203-
224+
<ul>
225+
<li>
226+
<strong><code>door_description</code></strong> <i>String</i>
227+
</li>
228+
<li>
229+
<strong><code>door_name</code></strong> <i>String</i>
230+
</li>
231+
<li>
232+
<strong><code>ext_door_id</code></strong> <i>String</i>
233+
</li>
234+
</ul>
204235
</details>
205236

206237
---
@@ -214,34 +245,39 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
214245
<details>
215246
<summary>Child Properties</summary>
216247

217-
- <strong><code>door_category</code></strong> <i>Enum</i>
218-
<details>
219-
<summary>Enum values:</summary>
220-
221-
- <code>entrance`</code>
222-
- <code>guest`</code>
223-
- <code>elevator reader`</code>
224-
- <code>common`</code>
225-
- <code>common (PMS)`</code>
226-
</details>
227-
228-
- <strong><code>door_name</code></strong> <i>String</i>
229-
230-
- <strong><code>profiles</code></strong> <i>List</i> <i>of Objects</i>
231-
232-
- <strong><code>visionline_door_profile_id</code></strong> <i>String</i>
233-
234-
235-
- <strong><code>visionline_door_profile_type</code></strong> <i>Enum</i>
236-
<details>
237-
<summary>Enum values:</summary>
238-
239-
- <code>BLE`</code>
240-
- <code>commonDoor`</code>
241-
- <code>touch`</code>
242-
</details>
243-
244-
248+
<ul>
249+
<li>
250+
<strong><code>door_category</code></strong> <i>Enum</i>
251+
<details>
252+
<summary>Enum values:</summary>
253+
254+
- <code>entrance`</code>
255+
- <code>guest`</code>
256+
- <code>elevator reader`</code>
257+
- <code>common`</code>
258+
- <code>common (PMS)`</code>
259+
</details>
260+
</li>
261+
<li>
262+
<strong><code>door_name</code></strong> <i>String</i>
263+
</li>
264+
<li>
265+
<strong><code>profiles</code></strong> <i>List</i> <i>of Objects</i>
266+
267+
- <strong><code>visionline_door_profile_id</code></strong> <i>String</i>
268+
269+
270+
- <strong><code>visionline_door_profile_type</code></strong> <i>Enum</i>
271+
<details>
272+
<summary>Enum values:</summary>
273+
274+
- <code>BLE`</code>
275+
- <code>commonDoor`</code>
276+
- <code>touch`</code>
277+
</details>
278+
279+
</li>
280+
</ul>
245281
</details>
246282

247283
---

‎docs/api/acs/systems/README.md‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -450,10 +450,13 @@ Indicates whether the `acs_system` is a credential manager.
450450
<details>
451451
<summary>Child Properties</summary>
452452

453-
- <strong><code>time_zone</code></strong> <i>String</i>
454-
455-
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
456-
453+
<ul>
454+
<li>
455+
<strong><code>time_zone</code></strong> <i>String</i>
456+
457+
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
458+
</li>
459+
</ul>
457460
</details>
458461

459462
---
@@ -514,18 +517,23 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
514517
<details>
515518
<summary>Child Properties</summary>
516519

517-
- <strong><code>lan_address</code></strong> <i>String</i>
518-
519-
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
520-
521-
- <strong><code>mobile_access_uuid</code></strong> <i>String</i>
522-
523-
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
524-
525-
- <strong><code>system_id</code></strong> <i>String</i>
526-
527-
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
528-
520+
<ul>
521+
<li>
522+
<strong><code>lan_address</code></strong> <i>String</i>
523+
524+
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
525+
</li>
526+
<li>
527+
<strong><code>mobile_access_uuid</code></strong> <i>String</i>
528+
529+
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
530+
</li>
531+
<li>
532+
<strong><code>system_id</code></strong> <i>String</i>
533+
534+
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
535+
</li>
536+
</ul>
529537
</details>
530538

531539
---

0 commit comments

Comments
 (0)