Skip to content

Change generated API ref look and feel #542

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.

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 69 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
71d85bf
Change namespace layout slightly
DebbieAtSeam Mar 26, 2025
0b2e0af
ci: Generate docs
seambot Mar 26, 2025
5e61d46
Update api-namespace.hbs
DebbieAtSeam Mar 26, 2025
03d7d33
ci: Generate docs
seambot Mar 26, 2025
064022d
Update api-route.hbs
DebbieAtSeam Mar 26, 2025
888505a
ci: Generate docs
seambot Mar 26, 2025
e2b0275
Update api-resource.hbs
DebbieAtSeam Mar 26, 2025
b40e4ed
ci: Generate docs
seambot Mar 26, 2025
1373b45
Update api-resource.hbs
DebbieAtSeam Mar 26, 2025
e05c000
ci: Generate docs
seambot Mar 26, 2025
11f9f89
Update api-resource.hbs
DebbieAtSeam Mar 26, 2025
a801425
ci: Generate docs
seambot Mar 26, 2025
34737c5
Update api-resource.hbs
DebbieAtSeam Mar 26, 2025
04705d9
ci: Generate docs
seambot Mar 26, 2025
a0140ac
Update acs-users.yaml
DebbieAtSeam Mar 26, 2025
c614e4e
ci: Generate docs
seambot Mar 26, 2025
2b6e971
Merge branch 'main' into change-api-ref-look-and-feel
razor-x Mar 26, 2025
5519bcf
ci: Generate docs
seambot Mar 26, 2025
802f992
Update api-endpoint.hbs
DebbieAtSeam Mar 26, 2025
5268d8f
ci: Generate docs
seambot Mar 26, 2025
8ec7f59
Update api-endpoint.hbs
DebbieAtSeam Mar 26, 2025
09dcacc
ci: Generate docs
seambot Mar 26, 2025
2d17524
Update api-endpoint.hbs
DebbieAtSeam Mar 26, 2025
7b55ca8
Update api-endpoint.hbs
DebbieAtSeam Mar 26, 2025
56fb11c
ci: Generate docs
seambot Mar 26, 2025
667f07c
Update api-endpoint.hbs
DebbieAtSeam Mar 26, 2025
cd8ec0b
ci: Generate docs
seambot Mar 26, 2025
bbe9c08
Merge branch 'main' into change-api-ref-look-and-feel
DebbieAtSeam Mar 27, 2025
028b008
ci: Generate docs
seambot Mar 27, 2025
056f4b7
Update code-sample.hbs
DebbieAtSeam Mar 27, 2025
db4a4c3
ci: Generate docs
seambot Mar 27, 2025
5bd81dd
Update api-endpoint.hbs
DebbieAtSeam Mar 27, 2025
fd2abce
Update api-endpoint.hbs
DebbieAtSeam Mar 27, 2025
d718e19
ci: Generate docs
seambot Mar 27, 2025
6bcd338
Update api-endpoint.hbs
DebbieAtSeam Mar 27, 2025
2133a41
ci: Generate docs
seambot Mar 27, 2025
3c9bfdc
Add access codes to gen
DebbieAtSeam Mar 27, 2025
49a6912
Add access codes to gen
DebbieAtSeam Mar 27, 2025
d9f3c17
ci: Generate docs
seambot Mar 27, 2025
4d19691
Alphabetize SUMMARY.md
DebbieAtSeam Mar 27, 2025
1d38634
Update paths.yaml
DebbieAtSeam Mar 27, 2025
4d0a542
ci: Generate docs
seambot Mar 27, 2025
bd2a0ad
Update api-endpoint.hbs
DebbieAtSeam Mar 27, 2025
5bf47d6
ci: Generate docs
seambot Mar 27, 2025
6620619
Update SUMMARY.md
DebbieAtSeam Mar 27, 2025
196d81d
Update paths.yaml
DebbieAtSeam Mar 27, 2025
49dec45
ci: Generate docs
seambot Mar 27, 2025
355aeab
Merge branch 'main' into change-api-ref-look-and-feel
DebbieAtSeam Mar 28, 2025
2b84a06
Merge branch 'main' into change-api-ref-look-and-feel
DebbieAtSeam Mar 28, 2025
95d00cb
Merge branch 'main' into change-api-ref-look-and-feel
DebbieAtSeam Mar 28, 2025
e7a5612
ci: Generate docs
seambot Mar 28, 2025
d4a0412
Merge branch 'main' into change-api-ref-look-and-feel
DebbieAtSeam Mar 28, 2025
d8a1e32
Update paths.yaml
DebbieAtSeam Mar 28, 2025
7621455
Update SUMMARY.md
DebbieAtSeam Mar 28, 2025
ce6d871
ci: Generate docs
seambot Mar 28, 2025
8f6db2b
Fix typo
andrii-balitskyi Mar 31, 2025
f435440
Add item format for array request params
andrii-balitskyi Mar 31, 2025
db30d74
Fix blueprint registry url
andrii-balitskyi Mar 31, 2025
140dfa4
ci: Generate docs
seambot Mar 31, 2025
192818d
Normalize item format, fix enum values
andrii-balitskyi Mar 31, 2025
ba841b5
ci: Format code
seambot Mar 31, 2025
8b135cf
ci: Generate docs
seambot Mar 31, 2025
7a04ff4
Use enum partial
andrii-balitskyi Mar 31, 2025
03f1377
Put desctiption before possible enum values
andrii-balitskyi Mar 31, 2025
581af96
ci: Generate docs
seambot Mar 31, 2025
8c14cfa
Merge array-item-format into change-api-ref-look-and-feel
DebbieAtSeam Mar 31, 2025
2f17cc5
ci: Generate docs
seambot Mar 31, 2025
8027612
Merge branch 'main' into change-api-ref-look-and-feel
DebbieAtSeam Mar 31, 2025
9d27b5f
Merge branch 'main' into change-api-ref-look-and-feel
DebbieAtSeam Apr 1, 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
82 changes: 41 additions & 41 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,36 +126,6 @@
* [Overview](api-clients/overview.md)
* [Installation](api-clients/installation.md)
* [Authentication](api-clients/authentication.md)
* [Workspaces](api-clients/workspaces/README.md)
* [Get Workspace](api-clients/workspaces/get.md)
* [Reset Workspace](api-clients/workspaces/reset_sandbox.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)
* [Connected Accounts](api-clients/connected_accounts/README.md)
* [Get a Connected Account](api-clients/connected_accounts/get.md)
* [List Connected Accounts](api-clients/connected_accounts/list.md)
* [Update a Connected Account](api-clients/connected_accounts/update.md)
* [Delete a Connected Account](api-clients/connected_accounts/delete.md)
* [Devices](api-clients/devices/README.md)
* [List Devices](api-clients/devices/list.md)
* [List Device Providers](api-clients/devices/list_device_providers.md)
* [Device Provider Metadata](reference/device-provider-metadata.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)
* [Access Codes](api-clients/access_codes/README.md)
* [Create an Access Code](api-clients/access_codes/create.md)
* [Create Multiple Linked Access Codes](api-clients/access_codes/create_multiple.md)
Expand All @@ -169,12 +139,7 @@
* [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md)
* [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md)
* [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.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)
* [Access Control Systems](api/acs/README.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)
Expand Down Expand Up @@ -217,6 +182,43 @@
* [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)
* [Connected Accounts](api-clients/connected_accounts/README.md)
* [Get a Connected Account](api-clients/connected_accounts/get.md)
* [List Connected Accounts](api-clients/connected_accounts/list.md)
* [Update a Connected Account](api-clients/connected_accounts/update.md)
* [Delete a Connected Account](api-clients/connected_accounts/delete.md)
* [Devices](api-clients/devices/README.md)
* [List Devices](api-clients/devices/list.md)
* [List Device Providers](api-clients/devices/list_device_providers.md)
* [Device Provider Metadata](reference/device-provider-metadata.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 Noise Thresholds](api-clients/noise_sensors/noise_thresholds/create.md)
Expand Down Expand Up @@ -270,11 +272,9 @@
* [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)
* [Action Attempts](api-clients/action_attempts/README.md)
* [Get Action Attempt](api-clients/action_attempts/get.md)
* [Events](api-clients/events/README.md)
* [List Events](api-clients/events/list.md)
* [Get an Event](api-clients/events/get.md)
* [Workspaces](api-clients/workspaces/README.md)
* [Get Workspace](api-clients/workspaces/get.md)
* [Reset Workspace](api-clients/workspaces/reset_sandbox.md)

## 🛠️ Developer Tools

Expand Down
28 changes: 27 additions & 1 deletion docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

### Routes

- `/access_codes`
- `/access_codes/simulate`
- `/access_codes/unmanaged`
- `/action_attempts`
Expand Down Expand Up @@ -198,12 +197,14 @@ Items that are intentionally undocumented are not included in this section.
- `client_session`
- `connect_webview`
- `connected_account`
- `device`
- `device_provider`
- `event`
- `network`
- `noise_threshold`
- `unmanaged_access_code`
- `unmanaged_acs_access_group`
- `unmanaged_device`
- `webhook`
- `workspace`

Expand Down Expand Up @@ -275,6 +276,18 @@ Items that are intentionally undocumented are not included in this section.
- `connected_account.errors`
- `connected_account.user_identifier`
- `connected_account.warnings`
- `device.can_hvac_cool`
- `device.can_hvac_heat`
- `device.can_hvac_heat_cool`
- `device.can_program_offline_access_codes`
- `device.can_program_online_access_codes`
- `device.can_remotely_lock`
- `device.can_remotely_unlock`
- `device.can_simulate_connection`
- `device.can_simulate_disconnection`
- `device.can_simulate_removal`
- `device.can_turn_off_hvac`
- `device.custom_metadata`
- `device_provider.can_hvac_cool`
- `device_provider.can_hvac_heat`
- `device_provider.can_hvac_heat_cool`
Expand Down Expand Up @@ -316,6 +329,19 @@ Items that are intentionally undocumented are not included in this section.
- `unmanaged_acs_user.is_managed`
- `unmanaged_acs_user.latest_desired_state_synced_with_provider_at`
- `unmanaged_acs_user.pending_modifications`
- `unmanaged_device.can_hvac_cool`
- `unmanaged_device.can_hvac_heat`
- `unmanaged_device.can_hvac_heat_cool`
- `unmanaged_device.can_program_offline_access_codes`
- `unmanaged_device.can_program_online_access_codes`
- `unmanaged_device.can_remotely_lock`
- `unmanaged_device.can_remotely_unlock`
- `unmanaged_device.can_simulate_connection`
- `unmanaged_device.can_simulate_disconnection`
- `unmanaged_device.can_simulate_removal`
- `unmanaged_device.can_turn_off_hvac`
- `unmanaged_device.is_managed`
- `unmanaged_device.properties`
- `user_identity.display_name`
- `user_identity.full_name`
- `webhook.event_types`
Expand Down
Loading
Loading