Skip to content

Commit e689b17

Browse files
razor-xseambot
razor-x
and
seambot
authored
Special layout handling for routes with groups (#687)
* Hide preamble for resources on secondary route * Filter resource samples that don't match filters * ci: Generate docs * Fix type error * Flatten properties when include is used * Flatten property groups when using include * ci: Generate docs * ci: Generate docs * Use arrow function * Sort errors by parentResouceType * ci: Generate docs * Hide hidePreamble for alt route paths * ci: Generate docs --------- Co-authored-by: Seam Bot <[email protected]>
1 parent 1bed827 commit e689b17

File tree

6 files changed

+926
-985
lines changed

6 files changed

+926
-985
lines changed

‎docs/api/access_codes/README.md‎

Lines changed: 80 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -2414,245 +2414,243 @@ Unable to confirm that the access code is set on Kwikset device.
24142414

24152415
## Errors
24162416

2417-
**`account_disconnected`**
2417+
**`wyze_potential_duplicate_code`**
24182418

2419-
Indicates that the account is disconnected.
2419+
Potential duplicate access code detected.
24202420

24212421
---
24222422

2423-
**`august_device_programming_delay`**
2423+
**`wyze_duplicate_code_name`**
24242424

2425-
Access code has not yet been fully moved to the device.
2425+
Duplicate access code name detected.
24262426

24272427
---
24282428

2429-
**`august_device_slots_full`**
2429+
**`smartthings_no_free_slots_available`**
24302430

2431-
All access code slots on the device are full.
2431+
No free slots available on the device.
24322432

24332433
---
24342434

2435-
**`august_lock_invalid_code_length`**
2435+
**`smartthings_failed_to_set_after_multiple_retries`**
24362436

2437-
Invalid code length for August lock.
2437+
Failed to set code after multiple retries.
24382438

24392439
---
24402440

2441-
**`august_lock_missing_keypad`**
2441+
**`smartthings_failed_to_set_access_code`**
24422442

2443-
August lock is missing a keypad.
2443+
Failed to set code on SmartThings device.
24442444

24452445
---
24462446

2447-
**`august_lock_temporarily_offline`**
2447+
**`salto_ks_user_not_subscribed`**
24482448

2449-
August lock is temporarily offline.
2449+
Salto site user is not subscribed.
24502450

24512451
---
24522452

2453-
**`bridge_disconnected`**
2453+
**`no_space_for_access_code_on_device`**
24542454

2455-
Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
2455+
No space for access code on device.
24562456

24572457
---
24582458

2459-
**`code_modified_external_to_seam`**
2459+
**`kwikset_unable_to_confirm_deletion`**
24602460

2461-
Code was modified or removed externally after Seam successfully set it on the device.
2461+
Unable to confirm the deletion of the access code on Kwikset device.
24622462

24632463
---
24642464

2465-
**`device_disconnected`**
2465+
**`kwikset_unable_to_confirm_code`**
24662466

2467-
Indicates that the device is disconnected.
2467+
Unable to confirm that the access code is set on Kwikset device.
24682468

24692469
---
24702470

2471-
**`device_offline`**
2471+
**`igloohome_offline_access_code_no_variance_available`**
24722472

2473-
Indicates that the device is offline.
2473+
Lock has reached maximum amount of codes.
24742474

24752475
---
24762476

2477-
**`device_removed`**
2477+
**`igloohome_bridge_too_many_pending_jobs`**
24782478

2479-
Indicates that the device has been removed.
2479+
Igloohome bridge has too many pending jobs in the queue.
24802480

24812481
---
24822482

2483-
**`dormakaba_oracode_no_valid_user_level`**
2483+
**`igloohome_bridge_offline`**
24842484

2485-
No valid user level for Oracode.
2485+
Igloohome bridge is offline.
24862486

24872487
---
24882488

2489-
**`duplicate_code_attempt_prevented`**
2489+
**`hubitat_no_free_positions_available`**
24902490

2491-
An attempt to modify this access code was prevented.
2491+
No free positions available on the device.
24922492

24932493
---
24942494

2495-
**`duplicate_code_on_device`**
2495+
**`hubitat_device_programming_delay`**
24962496

2497-
Duplicate access code detected on device.
2497+
Access code has not yet been fully moved to the device.
24982498

24992499
---
25002500

2501-
**`failed_to_remove_from_device`**
2501+
**`failed_to_set_on_device`**
25022502

2503-
Failed to remove code from device.
2503+
Failed to set code on device.
25042504

25052505
---
25062506

2507-
**`failed_to_set_on_device`**
2507+
**`failed_to_remove_from_device`**
25082508

2509-
Failed to set code on device.
2509+
Failed to remove code from device.
25102510

25112511
---
25122512

2513-
**`hub_disconnected`**
2513+
**`duplicate_code_on_device`**
25142514

2515-
Indicates that the hub is disconnected.
2515+
Duplicate access code detected on device.
25162516

25172517
---
25182518

2519-
**`hubitat_device_programming_delay`**
2519+
**`duplicate_code_attempt_prevented`**
25202520

2521-
Access code has not yet been fully moved to the device.
2521+
An attempt to modify this access code was prevented.
25222522

25232523
---
25242524

2525-
**`hubitat_no_free_positions_available`**
2525+
**`dormakaba_oracode_no_valid_user_level`**
25262526

2527-
No free positions available on the device.
2527+
No valid user level for Oracode.
25282528

25292529
---
25302530

2531-
**`igloohome_bridge_offline`**
2531+
**`code_modified_external_to_seam`**
25322532

2533-
Igloohome bridge is offline.
2533+
Code was modified or removed externally after Seam successfully set it on the device.
25342534

25352535
---
25362536

2537-
**`igloohome_bridge_too_many_pending_jobs`**
2537+
**`august_lock_temporarily_offline`**
25382538

2539-
Igloohome bridge has too many pending jobs in the queue.
2539+
August lock is temporarily offline.
25402540

25412541
---
25422542

2543-
**`igloohome_offline_access_code_no_variance_available`**
2543+
**`august_lock_missing_keypad`**
25442544

2545-
Lock has reached maximum amount of codes.
2545+
August lock is missing a keypad.
25462546

25472547
---
25482548

2549-
**`invalid_credentials`**
2549+
**`august_lock_invalid_code_length`**
25502550

2551-
Indicates that the credentials provided were invalid.
2551+
Invalid code length for August lock.
25522552

25532553
---
25542554

2555-
**`kwikset_unable_to_confirm_code`**
2555+
**`august_device_slots_full`**
25562556

2557-
Unable to confirm that the access code is set on Kwikset device.
2557+
All access code slots on the device are full.
25582558

25592559
---
25602560

2561-
**`kwikset_unable_to_confirm_deletion`**
2561+
**`august_device_programming_delay`**
25622562

2563-
Unable to confirm the deletion of the access code on Kwikset device.
2563+
Access code has not yet been fully moved to the device.
25642564

25652565
---
25662566

2567-
**`lockly_missing_wifi_bridge`**
2567+
**`account_disconnected`**
25682568

2569-
Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
2569+
Indicates that the account is disconnected.
25702570

25712571
---
25722572

2573-
**`missing_device_credentials`**
2573+
**`august_lock_missing_bridge`**
25742574

2575-
Indicates that device credentials are missing.
2575+
Indicates that the lock is not connected to a bridge.
25762576

25772577
---
25782578

2579-
**`no_space_for_access_code_on_device`**
2579+
**`august_lock_not_authorized`**
25802580

2581-
No space for access code on device.
2581+
Indicates that the user is not authorized to use the August lock.
25822582

25832583
---
25842584

2585-
**`salto_ks_user_not_subscribed`**
2585+
**`bridge_disconnected`**
25862586

2587-
Salto site user is not subscribed.
2587+
Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
25882588

25892589
---
25902590

2591-
**`smartthings_failed_to_set_access_code`**
2591+
**`device_disconnected`**
25922592

2593-
Failed to set code on SmartThings device.
2593+
Indicates that the device is disconnected.
25942594

25952595
---
25962596

2597-
**`smartthings_failed_to_set_after_multiple_retries`**
2597+
**`device_offline`**
25982598

2599-
Failed to set code after multiple retries.
2599+
Indicates that the device is offline.
26002600

26012601
---
26022602

2603-
**`smartthings_no_free_slots_available`**
2603+
**`device_removed`**
26042604

2605-
No free slots available on the device.
2605+
Indicates that the device has been removed.
26062606

26072607
---
26082608

2609-
**`subscription_required`**
2609+
**`empty_backup_access_code_pool`**
26102610

2611-
Indicates that a subscription is required to connect.
2611+
Indicates that the [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) is empty.
26122612

26132613
---
26142614

2615-
**`ttlock_lock_not_paired_to_gateway`**
2615+
**`hub_disconnected`**
26162616

2617-
Indicates that the lock is not paired with a gateway.
2617+
Indicates that the hub is disconnected.
26182618

26192619
---
26202620

2621-
**`wyze_duplicate_code_name`**
2621+
**`invalid_credentials`**
26222622

2623-
Duplicate access code name detected.
2623+
Indicates that the credentials provided were invalid.
26242624

26252625
---
26262626

2627-
**`wyze_potential_duplicate_code`**
2627+
**`lockly_missing_wifi_bridge`**
26282628

2629-
Potential duplicate access code detected.
2629+
Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
26302630

26312631
---
26322632

2633-
### Access Codes
2634-
**`empty_backup_access_code_pool`**
2633+
**`missing_device_credentials`**
26352634

2636-
Indicates that the [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) is empty.
2635+
Indicates that device credentials are missing.
26372636

26382637
---
26392638

2640-
### Locks
2641-
**`august_lock_missing_bridge`**
2639+
**`salto_ks_subscription_limit_exceeded`**
26422640

2643-
Indicates that the lock is not connected to a bridge.
2641+
Indicates that the Salto site user limit has been reached.
26442642

26452643
---
26462644

2647-
**`august_lock_not_authorized`**
2645+
**`subscription_required`**
26482646

2649-
Indicates that the user is not authorized to use the August lock.
2647+
Indicates that a subscription is required to connect.
26502648

26512649
---
26522650

2653-
**`salto_ks_subscription_limit_exceeded`**
2651+
**`ttlock_lock_not_paired_to_gateway`**
26542652

2655-
Indicates that the Salto site user limit has been reached.
2653+
Indicates that the lock is not paired with a gateway.
26562654

26572655
---
26582656

0 commit comments

Comments
 (0)