Skip to content

Commit fbfc3bf

Browse files
Fix docs rendering for object variants in list properties (#621)
Co-authored-by: Seam Bot <seambot@getseam.com>
1 parent eba913d commit fbfc3bf

8 files changed

Lines changed: 200 additions & 149 deletions

File tree

docs/api/access_codes/README.md

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

docs/api/access_codes/unmanaged/README.md

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

docs/api/acs/credentials/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi
371371

372372
Enum values:
373373

374-
- <code>waiting_to_be_issued</code>
374+
- <code>waiting_to_be_issued</code>
375375

376376

377377
</details>
@@ -403,7 +403,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide
403403

404404
Enum values:
405405

406-
- <code>schedule_externally_modified</code>
406+
- <code>schedule_externally_modified</code>
407407

408408

409409
</details>
@@ -435,7 +435,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces
435435

436436
Enum values:
437437

438-
- <code>schedule_modified</code>
438+
- <code>schedule_modified</code>
439439

440440

441441
</details>
@@ -467,7 +467,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi
467467

468468
Enum values:
469469

470-
- <code>being_deleted</code>
470+
- <code>being_deleted</code>
471471

472472

473473
</details>
@@ -499,7 +499,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c
499499

500500
Enum values:
501501

502-
- <code>unknown_issue_with_acs_credential</code>
502+
- <code>unknown_issue_with_acs_credential</code>
503503

504504

505505
</details>
@@ -531,7 +531,7 @@ Access permissions for the [credential](../../../capability-guides/access-system
531531

532532
Enum values:
533533

534-
- <code>needs_to_be_reissued</code>
534+
- <code>needs_to_be_reissued</code>
535535

536536

537537
</details>

docs/api/acs/systems/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab
164164

165165
Enum values:
166166

167-
- <code>seam_bridge_disconnected</code>
167+
- <code>seam_bridge_disconnected</code>
168168

169169

170170
---
@@ -197,7 +197,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab
197197

198198
Enum values:
199199

200-
- <code>bridge_disconnected</code>
200+
- <code>bridge_disconnected</code>
201201

202202

203203
---
@@ -237,7 +237,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct
237237

238238
Enum values:
239239

240-
- <code>visionline_instance_unreachable</code>
240+
- <code>visionline_instance_unreachable</code>
241241

242242

243243
---
@@ -269,7 +269,7 @@ Indicates that the maximum number of users allowed for the site has been reached
269269

270270
Enum values:
271271

272-
- <code>salto_ks_subscription_limit_exceeded</code>
272+
- <code>salto_ks_subscription_limit_exceeded</code>
273273

274274

275275
---
@@ -301,7 +301,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit
301301

302302
Enum values:
303303

304-
- <code>acs_system_disconnected</code>
304+
- <code>acs_system_disconnected</code>
305305

306306

307307
---
@@ -333,7 +333,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a
333333

334334
Enum values:
335335

336-
- <code>account_disconnected</code>
336+
- <code>account_disconnected</code>
337337

338338

339339
---
@@ -365,7 +365,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit
365365

366366
Enum values:
367367

368-
- <code>salto_ks_certification_expired</code>
368+
- <code>salto_ks_certification_expired</code>
369369

370370

371371
---
@@ -568,7 +568,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow
568568

569569
Enum values:
570570

571-
- <code>salto_ks_subscription_limit_almost_reached</code>
571+
- <code>salto_ks_subscription_limit_almost_reached</code>
572572

573573

574574
</details>
@@ -610,7 +610,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui
610610

611611
Enum values:
612612

613-
- <code>time_zone_does_not_match_location</code>
613+
- <code>time_zone_does_not_match_location</code>
614614

615615

616616
</details>

docs/api/acs/users/README.md

Lines changed: 65 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system
9191

9292
**`connected_account_id`** *UUID*
9393

94-
95-
The ID of the [connected account](../../../core-concepts/connected-accounts/README.md) that is associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
96-
94+
The ID of the [connected account](../../../core-concepts/connected-accounts/README.md) that is associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
9795

9896

9997

@@ -166,7 +164,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
166164

167165
Enum values:
168166

169-
- <code>deleted_externally</code>
167+
- <code>deleted_externally</code>
170168

171169

172170
---
@@ -196,7 +194,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
196194

197195
Enum values:
198196

199-
- <code>salto_ks_subscription_limit_exceeded</code>
197+
- <code>salto_ks_subscription_limit_exceeded</code>
200198

201199

202200
---
@@ -226,7 +224,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
226224

227225
Enum values:
228226

229-
- <code>failed_to_create_on_acs_system</code>
227+
- <code>failed_to_create_on_acs_system</code>
230228

231229

232230
---
@@ -256,7 +254,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
256254

257255
Enum values:
258256

259-
- <code>failed_to_update_on_acs_system</code>
257+
- <code>failed_to_update_on_acs_system</code>
260258

261259

262260
---
@@ -286,7 +284,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
286284

287285
Enum values:
288286

289-
- <code>failed_to_delete_on_acs_system</code>
287+
- <code>failed_to_delete_on_acs_system</code>
290288

291289

292290
---
@@ -316,7 +314,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
316314

317315
Enum values:
318316

319-
- <code>latch_conflict_with_resident_user</code>
317+
- <code>latch_conflict_with_resident_user</code>
320318

321319

322320
---
@@ -430,7 +428,7 @@ Seam is in the process of pushing a user creation to the integrated access syste
430428

431429
Enum values:
432430

433-
- <code>creating</code>
431+
- <code>creating</code>
434432

435433

436434
</details>
@@ -460,7 +458,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste
460458

461459
Enum values:
462460

463-
- <code>deleting</code>
461+
- <code>deleting</code>
464462

465463

466464
</details>
@@ -478,6 +476,14 @@ Seam is in the process of pushing a user deletion to the integrated access syste
478476
**`from`** *Object*
479477

480478

479+
Child Properties
480+
481+
- <strong><code>email_address</code></strong> <i>String</i>
482+
483+
- <strong><code>full_name</code></strong> <i>String</i>
484+
485+
- <strong><code>phone_number</code></strong> <i>String</i>
486+
481487

482488
---
483489

@@ -494,14 +500,22 @@ Seam is in the process of pushing a user deletion to the integrated access syste
494500

495501
Enum values:
496502

497-
- <code>updating_user_information</code>
503+
- <code>updating_user_information</code>
498504

499505

500506
---
501507

502508
**`to`** *Object*
503509

504510

511+
Child Properties
512+
513+
- <strong><code>email_address</code></strong> <i>String</i>
514+
515+
- <strong><code>full_name</code></strong> <i>String</i>
516+
517+
- <strong><code>phone_number</code></strong> <i>String</i>
518+
505519

506520
</details>
507521
<details>
@@ -520,6 +534,12 @@ Seam is in the process of pushing an access schedule update to the integrated ac
520534
**`from`** *Object*
521535

522536

537+
Child Properties
538+
539+
- <strong><code>ends_at</code></strong> <i>Datetime</i>
540+
541+
- <strong><code>starts_at</code></strong> <i>Datetime</i>
542+
523543

524544
---
525545

@@ -536,14 +556,20 @@ Seam is in the process of pushing an access schedule update to the integrated ac
536556

537557
Enum values:
538558

539-
- <code>updating_access_schedule</code>
559+
- <code>updating_access_schedule</code>
540560

541561

542562
---
543563

544564
**`to`** *Object*
545565

546566

567+
Child Properties
568+
569+
- <strong><code>ends_at</code></strong> <i>Datetime</i>
570+
571+
- <strong><code>starts_at</code></strong> <i>Datetime</i>
572+
547573

548574
</details>
549575
<details>
@@ -562,6 +588,10 @@ Seam is in the process of pushing a suspension state update to the integrated ac
562588
**`from`** *Object*
563589

564590

591+
Child Properties
592+
593+
- <strong><code>is_suspended</code></strong> <i>Boolean</i>
594+
565595

566596
---
567597

@@ -578,14 +608,18 @@ Seam is in the process of pushing a suspension state update to the integrated ac
578608

579609
Enum values:
580610

581-
- <code>updating_suspension_state</code>
611+
- <code>updating_suspension_state</code>
582612

583613

584614
---
585615

586616
**`to`** *Object*
587617

588618

619+
Child Properties
620+
621+
- <strong><code>is_suspended</code></strong> <i>Boolean</i>
622+
589623

590624
</details>
591625
<details>
@@ -606,6 +640,12 @@ Seam is in the process of pushing an access group membership update to the integ
606640

607641
Old access group membership.
608642

643+
Child Properties
644+
645+
- <strong><code>acs_access_group_id</code></strong> <i>UUID</i>
646+
647+
Old access group ID.
648+
609649

610650
---
611651

@@ -622,7 +662,7 @@ Seam is in the process of pushing an access group membership update to the integ
622662

623663
Enum values:
624664

625-
- <code>updating_group_membership</code>
665+
- <code>updating_group_membership</code>
626666

627667

628668
---
@@ -632,6 +672,12 @@ Seam is in the process of pushing an access group membership update to the integ
632672

633673
New access group membership.
634674

675+
Child Properties
676+
677+
- <strong><code>acs_access_group_id</code></strong> <i>UUID</i>
678+
679+
New access group ID.
680+
635681

636682
</details>
637683

@@ -718,7 +764,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
718764

719765
Enum values:
720766

721-
- <code>being_deleted</code>
767+
- <code>being_deleted</code>
722768

723769

724770
</details>
@@ -748,7 +794,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
748794

749795
Enum values:
750796

751-
- <code>salto_ks_user_not_subscribed</code>
797+
- <code>salto_ks_user_not_subscribed</code>
752798

753799

754800
</details>
@@ -778,7 +824,7 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc
778824

779825
Enum values:
780826

781-
- <code>unknown_issue_with_acs_user</code>
827+
- <code>unknown_issue_with_acs_user</code>
782828

783829

784830
</details>
@@ -808,7 +854,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce
808854

809855
Enum values:
810856

811-
- <code>latch_resident_user</code>
857+
- <code>latch_resident_user</code>
812858

813859

814860
</details>

0 commit comments

Comments
 (0)