Skip to content

Commit 8afc164

Browse files
committed
ci: Generate docs
1 parent 52fb020 commit 8afc164

10 files changed

Lines changed: 168 additions & 0 deletions

File tree

docs/api/access_codes/README.md

Lines changed: 54 additions & 0 deletions
Large diffs are not rendered by default.

docs/api/access_codes/unmanaged/README.md

Lines changed: 54 additions & 0 deletions
Large diffs are not rendered by default.

docs/api/acs/access_groups/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ To learn whether your access control system supports access groups, see the corr
4848

4949
<details>
5050
<summary>Enum values</summary>
51+
5152
- <code>pti_unit</code>
5253
- <code>pti_access_level</code>
5354
- <code>salto_ks_access_group</code>
@@ -112,6 +113,7 @@ Brand-specific terminology for the access group type.
112113

113114
<details>
114115
<summary>Enum values</summary>
116+
115117
- <code>pti_unit</code>
116118
- <code>pti_access_level</code>
117119
- <code>salto_ks_access_group</code>
@@ -168,6 +170,7 @@ Warnings associated with the `acs_access_group`.
168170
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
169171
<details>
170172
<summary>Enum values:</summary>
173+
171174
- <code>unknown_issue_with_acs_access_group`</code>
172175
</details>
173176
</details>

docs/api/acs/credentials/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Access method for the [credential](../../../capability-guides/access-systems/man
6060

6161
<details>
6262
<summary>Enum values</summary>
63+
6364
- <code>code</code>
6465
- <code>card</code>
6566
- <code>mobile_key</code>
@@ -111,6 +112,7 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
111112

112113
<details>
113114
<summary>Child Properties</summary>
115+
114116
- <strong><code>auto_join</code></strong> <i>Boolean</i>
115117

116118
- <strong><code>door_names</code></strong> <i>List</i> <i>of Strings</i>
@@ -193,6 +195,7 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces
193195

194196
<details>
195197
<summary>Enum values</summary>
198+
196199
- <code>pti_card</code>
197200
- <code>brivo_credential</code>
198201
- <code>hid_credential</code>
@@ -303,11 +306,13 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
303306

304307
<details>
305308
<summary>Child Properties</summary>
309+
306310
- <strong><code>auto_join</code></strong> <i>Boolean</i>
307311

308312
- <strong><code>card_function_type</code></strong> <i>Enum</i>
309313
<details>
310314
<summary>Enum values:</summary>
315+
311316
- <code>guest`</code>
312317
- <code>staff`</code>
313318
</details>
@@ -365,6 +370,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi
365370
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
366371
<details>
367372
<summary>Enum values:</summary>
373+
368374
- <code>waiting_to_be_issued</code>
369375
</details>
370376

@@ -397,6 +403,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide
397403
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
398404
<details>
399405
<summary>Enum values:</summary>
406+
400407
- <code>schedule_externally_modified</code>
401408
</details>
402409

@@ -429,6 +436,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces
429436
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
430437
<details>
431438
<summary>Enum values:</summary>
439+
432440
- <code>schedule_modified</code>
433441
</details>
434442

@@ -461,6 +469,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi
461469
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
462470
<details>
463471
<summary>Enum values:</summary>
472+
464473
- <code>being_deleted</code>
465474
</details>
466475

@@ -493,6 +502,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c
493502
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
494503
<details>
495504
<summary>Enum values:</summary>
505+
496506
- <code>unknown_issue_with_acs_credential</code>
497507
</details>
498508

@@ -525,6 +535,7 @@ Access permissions for the [credential](../../../capability-guides/access-system
525535
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
526536
<details>
527537
<summary>Enum values:</summary>
538+
528539
- <code>needs_to_be_reissued</code>
529540
</details>
530541

docs/api/acs/encoders/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
9494
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
9595
<details>
9696
<summary>Enum values:</summary>
97+
9798
- <code>acs_encoder_removed`</code>
9899
</details>
99100
<strong><code>message</code></strong> <i>String</i>

docs/api/acs/entrances/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,15 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
6262

6363
<details>
6464
<summary>Child Properties</summary>
65+
6566
- <strong><code>door_name</code></strong> <i>String</i>
6667

6768
- <strong><code>door_number</code></strong> <i>Number</i>
6869

6970
- <strong><code>door_type</code></strong> <i>Enum</i>
7071
<details>
7172
<summary>Enum values:</summary>
73+
7274
- <code>CommonDoor`</code>
7375
- <code>EntranceDoor`</code>
7476
- <code>GuestDoor`</code>
@@ -109,6 +111,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
109111

110112
<details>
111113
<summary>Child Properties</summary>
114+
112115
- <strong><code>access_point_name</code></strong> <i>String</i>
113116

114117
</details>
@@ -141,6 +144,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
141144

142145
<details>
143146
<summary>Child Properties</summary>
147+
144148
- <strong><code>accessibility_type</code></strong> <i>String</i>
145149

146150
- <strong><code>door_name</code></strong> <i>String</i>
@@ -161,6 +165,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
161165

162166
<details>
163167
<summary>Child Properties</summary>
168+
164169
- <strong><code>battery_level</code></strong> <i>String</i>
165170

166171
- <strong><code>door_name</code></strong> <i>String</i>
@@ -189,6 +194,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
189194

190195
<details>
191196
<summary>Child Properties</summary>
197+
192198
- <strong><code>door_description</code></strong> <i>String</i>
193199

194200
- <strong><code>door_name</code></strong> <i>String</i>
@@ -207,9 +213,11 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
207213

208214
<details>
209215
<summary>Child Properties</summary>
216+
210217
- <strong><code>door_category</code></strong> <i>Enum</i>
211218
<details>
212219
<summary>Enum values:</summary>
220+
213221
- <code>entrance`</code>
214222
- <code>guest`</code>
215223
- <code>elevator reader`</code>
@@ -227,6 +235,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
227235
- <strong><code>visionline_door_profile_type</code></strong> <i>Enum</i>
228236
<details>
229237
<summary>Enum values:</summary>
238+
230239
- <code>BLE`</code>
231240
- <code>commonDoor`</code>
232241
- <code>touch`</code>

docs/api/acs/systems/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab
257257
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
258258
<details>
259259
<summary>Enum values:</summary>
260+
260261
- <code>seam_bridge_disconnected</code>
261262
</details>
262263

@@ -290,6 +291,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab
290291
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
291292
<details>
292293
<summary>Enum values:</summary>
294+
293295
- <code>bridge_disconnected</code>
294296
</details>
295297

@@ -330,6 +332,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct
330332
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
331333
<details>
332334
<summary>Enum values:</summary>
335+
333336
- <code>visionline_instance_unreachable</code>
334337
</details>
335338

@@ -362,6 +365,7 @@ Indicates that the maximum number of users allowed for the site has been reached
362365
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
363366
<details>
364367
<summary>Enum values:</summary>
368+
365369
- <code>salto_ks_subscription_limit_exceeded</code>
366370
</details>
367371

@@ -394,6 +398,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit
394398
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
395399
<details>
396400
<summary>Enum values:</summary>
401+
397402
- <code>acs_system_disconnected</code>
398403
</details>
399404

@@ -426,6 +431,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a
426431
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
427432
<details>
428433
<summary>Enum values:</summary>
434+
429435
- <code>account_disconnected</code>
430436
</details>
431437

@@ -458,6 +464,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit
458464
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
459465
<details>
460466
<summary>Enum values:</summary>
467+
461468
- <code>salto_ks_certification_expired</code>
462469
</details>
463470

@@ -481,6 +488,7 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/
481488

482489
<details>
483490
<summary>Enum values</summary>
491+
484492
- <code>pti_site</code>
485493
- <code>alta_org</code>
486494
- <code>salto_ks_site</code>
@@ -542,6 +550,7 @@ Indicates whether the `acs_system` is a credential manager.
542550

543551
<details>
544552
<summary>Child Properties</summary>
553+
545554
- <strong><code>time_zone</code></strong> <i>String</i>
546555

547556
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
@@ -568,6 +577,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
568577

569578
<details>
570579
<summary>Enum values</summary>
580+
571581
- <code>pti_site</code>
572582
- <code>alta_org</code>
573583
- <code>salto_ks_site</code>
@@ -604,6 +614,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
604614

605615
<details>
606616
<summary>Child Properties</summary>
617+
607618
- <strong><code>lan_address</code></strong> <i>String</i>
608619

609620
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
@@ -657,6 +668,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow
657668
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
658669
<details>
659670
<summary>Enum values:</summary>
671+
660672
- <code>salto_ks_subscription_limit_almost_reached</code>
661673
</details>
662674

@@ -699,6 +711,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui
699711
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
700712
<details>
701713
<summary>Enum values:</summary>
714+
702715
- <code>time_zone_does_not_match_location</code>
703716
</details>
704717

0 commit comments

Comments
 (0)