Skip to content

Inject API ref into SUMMARY.md #648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Inject API ref into SUMMARY.md #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01b21cc
Update SUMMARY.md in place with API ref section
razor-x Jun 12, 2025
928153e
Add missing newline
razor-x Jun 12, 2025
60234f9
ci: Generate docs
seambot Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
205 changes: 87 additions & 118 deletions docs/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,181 +132,150 @@
* [Installation](api-overview/installation.md)
* [Authentication](api-overview/authentication.md)
* [Pagination](api-overview/pagination.md)
<!-- begin api -->
* [Access Codes](api/access_codes/README.md)
* [Create an Access Code](api/access_codes/create.md)
* [Create Multiple Linked Access Codes](api/access_codes/create_multiple.md)
* [List Access Codes](api/access_codes/list.md)
* [Get an Access Code](api/access_codes/get.md)
* [Update an Access Code](api/access_codes/update.md)
* [Update Multiple Linked Access Codes](api/access_codes/update_multiple.md)
* [Delete an Access Code](api/access_codes/delete.md)
* [Generate a Code](api/access_codes/generate_code.md)
* [Get an Access Code](api/access_codes/get.md)
* [List Access Codes](api/access_codes/list.md)
* [Pull a Backup Access Code](api/access_codes/pull_backup_access_code.md)
* [Report Device Access Code Constraints](api/access_codes/report_device_constraints.md)
* [Unmanaged Access Codes](api/access_codes/unmanaged/README.md)
* [List Unmanaged Access Codes](api/access_codes/unmanaged/list.md)
* [Get an Unmanaged Access Code](api/access_codes/unmanaged/get.md)
* [Convert an Unmanaged Access Code](api/access_codes/unmanaged/convert_to_managed.md)
* [Update an Unmanaged Access Code](api/access_codes/unmanaged/update.md)
* [Delete an Unmanaged Access Code](api/access_codes/unmanaged/delete.md)
* [Update an Access Code](api/access_codes/update.md)
* [Update Multiple Linked Access Codes](api/access_codes/update_multiple.md)
* [Access Code Simulations](api/access_codes/simulate/README.md)
* [Simulate Creating an Unmanaged Access Code](api/access_codes/simulate/create_unmanaged_access_code.md)
* [Unmanaged Access Code](api/access_codes/unmanaged/README.md)
* [Convert an Unmanaged Access Code](api/access_codes/unmanaged/convert_to_managed.md)
* [Delete an Unmanaged Access Code](api/access_codes/unmanaged/delete.md)
* [Get an Unmanaged Access Code](api/access_codes/unmanaged/get.md)
* [List Unmanaged Access Codes](api/access_codes/unmanaged/list.md)
* [Update an Unmanaged Access Code](api/access_codes/unmanaged/update.md)
* [Access Control Systems (ACS)](api/acs/README.md)
* [Systems](api/acs/systems/README.md)
* [List ACS Systems](api/acs/systems/list.md)
* [Get an ACS System](api/acs/systems/get.md)
* [List Compatible Credential Manager ACS Systems](api/acs/systems/list_compatible_credential_manager_acs_systems.md)
* [Access Groups](api/acs/access_groups/README.md)
* [Add an ACS User to an Access Group](api/acs/access_groups/add_user.md)
* [Get an Access Group](api/acs/access_groups/get.md)
* [List Access Groups](api/acs/access_groups/list.md)
* [List ACS Users in an Access Group](api/acs/access_groups/list_users.md)
* [List Entrances Accessible to an Access Group](api/acs/access_groups/list_accessible_entrances.md)
* [Remove an ACS User from an Access Group](api/acs/access_groups/remove_user.md)
* [ACS Users](api/acs/users/README.md)
* [Add an ACS User to an Access Group](api/acs/users/add_to_access_group.md)
* [Create an ACS User](api/acs/users/create.md)
* [List ACS Users](api/acs/users/list.md)
* [Delete an ACS User](api/acs/users/delete.md)
* [Get an ACS User](api/acs/users/get.md)
* [Update an ACS User](api/acs/users/update.md)
* [List ACS User-Accessible Entrances](api/acs/users/list_accessible_entrances.md)
* [List ACS Users](api/acs/users/list.md)
* [Remove an ACS User from an Access Group](api/acs/users/remove_from_access_group.md)
* [Revoke ACS User Access to All Entrances](api/acs/users/revoke_access_to_all_entrances.md)
* [Suspend an ACS User](api/acs/users/suspend.md)
* [Unsuspend an ACS User](api/acs/users/unsuspend.md)
* [Delete an ACS User](api/acs/users/delete.md)
* [Add an ACS User to an Access Group](api/acs/users/add_to_access_group.md)
* [Remove an ACS User from an Access Group](api/acs/users/remove_from_access_group.md)
* [Entrances](api/acs/entrances/README.md)
* [List Entrances](api/acs/entrances/list.md)
* [Get an Entrance](api/acs/entrances/get.md)
* [List Credentials with Access to an Entrance](api/acs/entrances/list_credentials_with_access.md)
* [Access Groups](api/acs/access_groups/README.md)
* [List Access Groups](api/acs/access_groups/list.md)
* [Get an Access Group](api/acs/access_groups/get.md)
* [Add an ACS User to an Access Group](api/acs/access_groups/add_user.md)
* [Remove an ACS User from an Access Group](api/acs/access_groups/remove_user.md)
* [List ACS Users in an Access Group](api/acs/access_groups/list_users.md)
* [Update an ACS User](api/acs/users/update.md)
* [Credentials](api/acs/credentials/README.md)
* [Create a Credential for an ACS User](api/acs/credentials/create.md)
* [Assign a Credential to an ACS User](api/acs/credentials/assign.md)
* [List Credentials](api/acs/credentials/list.md)
* [Get a Credential](api/acs/credentials/get.md)
* [Update a Credential](api/acs/credentials/update.md)
* [Unassign a Credential from an ACS User](api/acs/credentials/unassign.md)
* [Create a Credential for an ACS User](api/acs/credentials/create.md)
* [Delete a Credential](api/acs/credentials/delete.md)
* [Get a Credential](api/acs/credentials/get.md)
* [List Accessible Entrances](api/acs/credentials/list_accessible_entrances.md)
* [List Credentials](api/acs/credentials/list.md)
* [Unassign a Credential from an ACS User](api/acs/credentials/unassign.md)
* [Update a Credential](api/acs/credentials/update.md)
* [Encoders](api/acs/encoders/README.md)
* [Encode a Credential](api/acs/encoders/encode_credential.md)
* [List Encoders](api/acs/encoders/list.md)
* [Encode an Access Method](api/acs/encoders/encode_access_method.md)
* [Get an Encoder](api/acs/encoders/get.md)
* [List Encoders](api/acs/encoders/list.md)
* [Scan a Credential](api/acs/encoders/scan_credential.md)
* [Encoder Simulations](api/acs/encoders/simulate/README.md)
* [Simulate that the Next Credential Encoding Will Fail](api/acs/encoders/simulate/next_credential_encode_will_fail.md)
* [Simulate that the Next Credential Encoding Will Succeed](api/acs/encoders/simulate/next_credential_encode_will_succeed.md)
* [Simulate that the Next Credential Scan Will Fail](api/acs/encoders/simulate/next_credential_scan_will_fail.md)
* [Simulate that the Next Credential Scan Will Succeed](api/acs/encoders/simulate/next_credential_scan_will_succeed.md)
* [Action Attempts](api-clients/action_attempts/README.md)
* [Get Action Attempt](api-clients/action_attempts/get.md)
* [Client Sessions](api-clients/client_sessions/README.md)
* [Create a Client Session](api-clients/client_sessions/create.md)
* [Get or Create a Client Session](api-clients/client_sessions/get_or_create.md)
* [List Client Sessions](api-clients/client_sessions/list.md)
* [Get a Client Session](api-clients/client_sessions/get.md)
* [Grant Access to a Client Session](api-clients/client_sessions/grant_access.md)
* [Delete a Client Session](api-clients/client_sessions/delete.md)
* [Connect Webviews](api-clients/connect_webviews/README.md)
* [Create a Connect Webview](api-clients/connect_webviews/create.md)
* [List Connect Webviews](api-clients/connect_webviews/list.md)
* [Get a Connect Webview](api-clients/connect_webviews/get.md)
* [Delete a Connect Webview](api-clients/connect_webviews/delete.md)
* [Entrances](api/acs/entrances/README.md)
* [Get an Entrance](api/acs/entrances/get.md)
* [Grant an ACS User Access to an Entrance](api/acs/entrances/grant_access.md)
* [List Credentials with Access to an Entrance](api/acs/entrances/list_credentials_with_access.md)
* [List Entrances](api/acs/entrances/list.md)
* [Systems](api/acs/systems/README.md)
* [Get an ACS System](api/acs/systems/get.md)
* [List ACS Systems](api/acs/systems/list.md)
* [List Compatible Credential Manager ACS Systems](api/acs/systems/list_compatible_credential_manager_acs_systems.md)
* [Access Grants](api/access_grants/README.md)
* [Create an Access Grant](api/access_grants/create.md)
* [Delete an Access Grant](api/access_grants/delete.md)
* [Get an Access Grant](api/access_grants/get.md)
* [List Access Grants](api/access_grants/list.md)
* [Access Methods](api/access_methods/README.md)
* [Delete an Access Method](api/access_methods/delete.md)
* [Get an Access Method](api/access_methods/get.md)
* [List Access Methods](api/access_methods/list.md)
* [Connected Accounts](api/connected_accounts/README.md)
* [Delete a Connected Account](api/connected_accounts/delete.md)
* [Get a Connected Account](api/connected_accounts/get.md)
* [List Connected Accounts](api/connected_accounts/list.md)
* [Update a Connected Account](api/connected_accounts/update.md)
* [Delete a Connected Account](api/connected_accounts/delete.md)
* [Sync a Connected Account](api/connected_accounts/sync.md)
* [Devices](api-clients/devices/README.md)
* [List Devices](api-clients/devices/list.md)
* [List Device Providers](api-clients/devices/list_device_providers.md)
* [Get a Device](api-clients/devices/get.md)
* [Update a Device](api-clients/devices/update.md)
* [Unmanaged Devices](api-clients/devices/unmanaged/README.md)
* [Update an Unmanaged Device](api-clients/devices/unmanaged/update.md)
* [List Unmanaged Devices](api-clients/devices/unmanaged/list.md)
* [Get an Unmanaged Device](api-clients/devices/unmanaged/get.md)
* [Events](api-clients/events/README.md)
* [List Events](api-clients/events/list.md)
* [Get an Event](api-clients/events/get.md)
* [Locks](api-clients/locks/README.md)
* [Get Lock](api-clients/locks/get.md)
* [Lock a Lock](api-clients/locks/lock_door.md)
* [Unlock a Lock](api-clients/locks/unlock_door.md)
* [List Locks](api-clients/locks/list.md)
* [Noise Sensors](api-clients/noise_sensors/README.md)
* [Noise Thresholds](api-clients/noise_sensors/noise_thresholds/README.md)
* [Create a Noise Threshold](api-clients/noise_sensors/noise_thresholds/create.md)
* [List Noise Thresholds](api-clients/noise_sensors/noise_thresholds/list.md)
* [Update a Noise Threshold](api-clients/noise_sensors/noise_thresholds/update.md)
* [Delete a Noise Threshold](api-clients/noise_sensors/noise_thresholds/delete.md)
* [Update a Connected Account](api/connected_accounts/update.md)
* [Phones](api/phones/README.md)
* [Deactivate a Phone](api/phones/deactivate.md)
* [Get a Phone](api/phones/get.md)
* [List Phones](api/phones/list.md)
* [Deactivate a Phone](api/phones/deactivate.md)
* [Phone Simulations](api/phones/simulate/README.md)
* [Create a Sandbox Phone](api/phones/simulate/create_sandbox_phone.md)
* [Spaces](api/spaces/README.md)
* [Add Devices to a Space](api/spaces/add_devices.md)
* [Add Entrances to a Space](api/spaces/add_acs_entrances.md)
* [Create a Space](api/spaces/create.md)
* [Delete a Space](api/spaces/delete.md)
* [Get a Space](api/spaces/get.md)
* [List Spaces](api/spaces/list.md)
* [Remove Devices from a Space](api/spaces/remove_devices.md)
* [Remove Entrances from a Space](api/spaces/remove_acs_entrances.md)
* [Update a Space](api/spaces/update.md)
* [Thermostats](api/thermostats/README.md)
* [Activate a Climate Preset](api/thermostats/activate_climate_preset.md)
* [Create a Climate Preset](api/thermostats/create_climate_preset.md)
* [Delete a Climate Preset](api/thermostats/delete_climate_preset.md)
* [List Thermostats](api/thermostats/list.md)
* [Set to Heat Mode](api/thermostats/heat.md)
* [Set a Temperature Threshold](api/thermostats/set_temperature_threshold.md)
* [Set the Fallback Climate Preset](api/thermostats/set_fallback_climate_preset.md)
* [Set the Fan Mode Setting](api/thermostats/set_fan_mode.md)
* [Set the HVAC Mode](api/thermostats/set_hvac_mode.md)
* [Set to Cool Mode](api/thermostats/cool.md)
* [Set to Heat Mode](api/thermostats/heat.md)
* [Set to Heat-Cool (Auto) Mode](api/thermostats/heat_cool.md)
* [Set to Off Mode](api/thermostats/off.md)
* [Set the HVAC Mode](api/thermostats/set_hvac_mode.md)
* [Set Fan Mode](api/thermostats/set_fan_mode.md)
* [Activate a Climate Preset](api/thermostats/activate_climate_preset.md)
* [Create a Climate Preset](api/thermostats/create_climate_preset.md)
* [Update a Climate Preset](api/thermostats/update_climate_preset.md)
* [Delete a Climate Preset](api/thermostats/delete_climate_preset.md)
* [Set a Fallback Climate Preset](api/thermostats/set_fallback_climate_preset.md)
* [Set a Temperature Threshold](api/thermostats/set_temperature_threshold.md)
* [Update the Thermostat Weekly Program](api/thermostats/update_weekly_program.md)
* [Thermostat Schedules](api/thermostats/schedules/README.md)
* [Create a Thermostat Schedule](api/thermostats/schedules/create.md)
* [Delete a Thermostat Schedule](api/thermostats/schedules/delete.md)
* [Get a Thermostat Schedule](api/thermostats/schedules/get.md)
* [List Thermostat Schedules](api/thermostats/schedules/list.md)
* [Create a Thermostat Schedule](api/thermostats/schedules/create.md)
* [Update a Thermostat Schedule](api/thermostats/schedules/update.md)
* [Delete a Thermostat Schedule](api/thermostats/schedules/delete.md)
* [Thermostat Simulations](api/thermostats/simulate/README.md)
* [Temperature Reached](api/thermostats/simulate/temperature_reached.md)
* [HVAC Mode Adjusted](api/thermostats/simulate/hvac_mode_adjusted.md)
* [Temperature Reached](api/thermostats/simulate/temperature_reached.md)
* [User Identities](api/user_identities/README.md)
* [Add an ACS User to a User Identity](api/user_identities/add_acs_user.md)
* [Create a User Identity](api/user_identities/create.md)
* [List User Identities](api/user_identities/list.md)
* [Get a User Identity](api/user_identities/get.md)
* [Delete a User Identity](api/user_identities/delete.md)
* [Generate an Instant Key](api/user_identities/generate_instant_key.md)
* [Update a User Identity](api/user_identities/update.md)
* [Add an ACS User to a User Identity](api/user_identities/add_acs_user.md)
* [List ACS Users Associated with a User Identity](api/user_identities/list_acs_users.md)
* [List ACS Systems Associated with a User Identity](api/user_identities/list_acs_systems.md)
* [Remove an ACS User from a User Identity](api/user_identities/remove_acs_user.md)
* [Get a User Identity](api/user_identities/get.md)
* [Grant a User Identity Access to a Device](api/user_identities/grant_access_to_device.md)
* [List Accessible Devices for a User Identity](api/user_identities/list_accessible_devices.md)
* [List ACS Systems Associated with a User Identity](api/user_identities/list_acs_systems.md)
* [List ACS Users Associated with a User Identity](api/user_identities/list_acs_users.md)
* [List User Identities](api/user_identities/list.md)
* [Remove an ACS User from a User Identity](api/user_identities/remove_acs_user.md)
* [Revoke Access to a Device from a User Identity](api/user_identities/revoke_access_to_device.md)
* [Delete a User Identity](api/user_identities/delete.md)
* [Update a User Identity](api/user_identities/update.md)
* [Enrollment Automations](api/user_identities/enrollment_automations/README.md)
* [Delete an Enrollment Automation](api/user_identities/enrollment_automations/delete.md)
* [Get an Enrollment Automation](api/user_identities/enrollment_automations/get.md)
* [Launch an Enrollment Automation](api/user_identities/enrollment_automations/launch.md)
* [List Enrollment Automations](api/user_identities/enrollment_automations/list.md)
* [Get an Enrollment Automation](api/user_identities/enrollment_automations/get.md)
* [Delete an Enrollment Automation](api/user_identities/enrollment_automations/delete.md)
* [Workspaces](api-clients/workspaces/README.md)
* [Get Workspace](api-clients/workspaces/get.md)
* [Reset Workspace](api-clients/workspaces/reset_sandbox.md)
* [Access Grants](api/access_grants/README.md)
* [Create an Access Grant](api/access_grants/create.md)
* [Delete an Access Grant](api/access_grants/delete.md)
* [Get an Access Grant](api/access_grants/get.md)
* [List Access Grants](api/access_grants/list.md)
* [Access Methods](api/access_methods/README.md)
* [Delete an Access Method](api/access_methods/delete.md)
* [Get an Access Method](api/access_methods/get.md)
* [List Access Methods](api/access_methods/list.md)
* [Spaces](api/spaces/README.md)
* [Add Devices to a Space](api/spaces/add_devices.md)
* [Add Entrances to a Space](api/spaces/add_acs_entrances.md)
* [Create a Space](api/spaces/create.md)
* [Delete a Space](api/spaces/delete.md)
* [Get a Space](api/spaces/get.md)
* [List Spaces](api/spaces/list.md)
* [Remove Devices from a Space](api/spaces/remove_devices.md)
* [Remove Entrances from a Space](api/spaces/remove_acs_entrances.md)
* [Update a Space](api/spaces/update.md)
<!-- end api -->

## 🛠️ Developer Tools

Expand Down
Loading
Loading