From db282ec27f0eee6e69d9cdc97533341b7f4ee2b9 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <84702959+andrii-balitskyi@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:59:41 +0100 Subject: [PATCH] Document Seam workspace scope (#483) Co-authored-by: Seam Bot --- docs/api/acs/access_groups/add_user.md | 1 + docs/api/acs/access_groups/get.md | 1 + docs/api/acs/access_groups/list.md | 1 + docs/api/acs/access_groups/list_accessible_entrances.md | 1 + docs/api/acs/access_groups/list_users.md | 1 + docs/api/acs/access_groups/remove_user.md | 1 + docs/api/acs/credentials/assign.md | 1 + docs/api/acs/credentials/create.md | 1 + docs/api/acs/credentials/delete.md | 1 + docs/api/acs/credentials/get.md | 1 + docs/api/acs/credentials/list.md | 1 + docs/api/acs/credentials/list_accessible_entrances.md | 1 + docs/api/acs/credentials/unassign.md | 1 + docs/api/acs/credentials/update.md | 1 + docs/api/acs/entrances/grant_access.md | 1 + docs/api/acs/entrances/list.md | 1 + docs/api/acs/entrances/list_credentials_with_access.md | 1 + docs/api/acs/systems/get.md | 1 + docs/api/acs/systems/list.md | 1 + .../systems/list_compatible_credential_manager_acs_systems.md | 1 + docs/api/acs/users/add_to_access_group.md | 1 + docs/api/acs/users/create.md | 1 + docs/api/acs/users/delete.md | 1 + docs/api/acs/users/get.md | 1 + docs/api/acs/users/list.md | 1 + docs/api/acs/users/list_accessible_entrances.md | 1 + docs/api/acs/users/remove_from_access_group.md | 1 + docs/api/acs/users/revoke_access_to_all_entrances.md | 1 + docs/api/acs/users/suspend.md | 1 + docs/api/acs/users/unsuspend.md | 1 + docs/api/acs/users/update.md | 1 + docs/api/thermostats/activate_climate_preset.md | 1 + docs/api/thermostats/cool.md | 1 + docs/api/thermostats/create_climate_preset.md | 1 + docs/api/thermostats/delete_climate_preset.md | 1 + docs/api/thermostats/heat.md | 1 + docs/api/thermostats/heat_cool.md | 1 + docs/api/thermostats/list.md | 1 + docs/api/thermostats/off.md | 1 + docs/api/thermostats/schedules/create.md | 1 + docs/api/thermostats/schedules/delete.md | 1 + docs/api/thermostats/schedules/get.md | 1 + docs/api/thermostats/schedules/list.md | 1 + docs/api/thermostats/schedules/update.md | 1 + docs/api/thermostats/set_fallback_climate_preset.md | 1 + docs/api/thermostats/set_fan_mode.md | 1 + docs/api/thermostats/set_hvac_mode.md | 1 + docs/api/thermostats/set_temperature_threshold.md | 1 + docs/api/thermostats/update_climate_preset.md | 1 + docs/api/user_identities/add_acs_user.md | 1 + docs/api/user_identities/create.md | 1 + docs/api/user_identities/delete.md | 1 + docs/api/user_identities/enrollment_automations/delete.md | 1 + docs/api/user_identities/enrollment_automations/get.md | 1 + docs/api/user_identities/enrollment_automations/launch.md | 1 + docs/api/user_identities/enrollment_automations/list.md | 1 + docs/api/user_identities/get.md | 1 + docs/api/user_identities/grant_access_to_device.md | 1 + docs/api/user_identities/list.md | 1 + docs/api/user_identities/list_accessible_devices.md | 1 + docs/api/user_identities/list_acs_systems.md | 1 + docs/api/user_identities/list_acs_users.md | 1 + docs/api/user_identities/remove_acs_user.md | 1 + docs/api/user_identities/revoke_access_to_device.md | 1 + docs/api/user_identities/update.md | 1 + src/layouts/api-endpoint.hbs | 3 +++ src/lib/layout/api-endpoint.ts | 3 +++ 67 files changed, 71 insertions(+) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index f099cc1e..983d0541 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -123,6 +123,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 18115e05..e33a8cb1 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -170,6 +170,7 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 615e721a..103b790b 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -189,6 +189,7 @@ func main() { - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index f50ebf67..265ab76d 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -164,6 +164,7 @@ func main() { - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 36c393e2..c366a94a 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -222,6 +222,7 @@ func main() { - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 5995686f..6902f839 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -123,6 +123,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 5e6cdda6..e1cae31f 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -123,6 +123,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index c71a4493..af1e25bf 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -211,6 +211,7 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 2ff52117..9a0fee13 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -114,6 +114,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index b726f644..649794ce 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -165,6 +165,7 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 96f6110c..d4fde243 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -195,6 +195,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3a2de649..3dddcd87 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -209,6 +209,7 @@ func main() { - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 2123ca63..187a30eb 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -123,6 +123,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 254aa8ef..549c4a2b 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -119,6 +119,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 56c2c448..8ea04aa6 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -10,6 +10,7 @@ POST /acs/entrances/grant_access ⇒ void - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 7a29fc8b..acf540d2 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -139,6 +139,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 231dd2bb..6cd85a7b 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -236,6 +236,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 4abe0d5d..a4c54c15 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -115,6 +115,7 @@ func main() { - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 385c3087..61766cfe 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -120,6 +120,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 70ccf581..64204002 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -123,6 +123,7 @@ func main() { - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 23cbb040..220fea9d 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -123,6 +123,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 92d4d04a..c00865cb 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -184,6 +184,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index a317a842..fcae60e5 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -112,6 +112,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 6de96804..997149da 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -158,6 +158,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 42eef5bd..050e628c 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -149,6 +149,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 71937db7..c5c4ad63 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -11,6 +11,7 @@ Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 97d9c9ac..7a580880 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -123,6 +123,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index f355e7c4..8a535716 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -10,6 +10,7 @@ Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index cbbb09b3..3e7988c6 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -112,6 +112,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 88a38975..e2f624dd 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -114,6 +114,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 8e5f6aed..8d068de4 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -122,6 +122,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index e236ce00..d191efa2 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -142,6 +142,7 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index b4a507f0..ba72ba2a 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -143,6 +143,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 36f83d5c..e43c34c7 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -152,6 +152,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 06b8c357..b078a805 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -121,6 +121,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 8dbed036..4e6aea06 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -143,6 +143,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index fb3c43ea..4577da40 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -149,6 +149,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index a48160e5..94349fcb 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -224,6 +224,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 0f4cb88b..0c9bf6dd 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -133,6 +133,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index d0e42ea4..4629eac5 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -185,6 +185,7 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746 - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 6dac5a6f..ca4fc457 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -117,6 +117,7 @@ nil - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index c6fef40a..1534426d 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -158,6 +158,7 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index c9724b2d..3ee8d746 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -211,6 +211,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 16c003d7..57fadde3 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -124,6 +124,7 @@ nil - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 2b9eab2b..2cbfe3e0 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -121,6 +121,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 3121da5d..988d8cfb 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -143,6 +143,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 6d5f0d71..8444c23f 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -154,6 +154,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index fbc68384..ca66a4ec 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -127,6 +127,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index c69a3c06..58ac59cb 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -132,6 +132,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 88519418..af928ae4 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -122,6 +122,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 5bc9667d..817473e5 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -178,6 +178,7 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 7638681e..2bdc55ac 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -113,6 +113,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 6660c338..2e1962b9 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -118,6 +118,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index b32beb3e..b53917f3 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -162,6 +162,7 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index e93b4703..a31b946e 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -176,6 +176,7 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 0045dc72..8ed1a89c 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -172,6 +172,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 33a8cede..0ae00b6d 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -159,6 +159,7 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 84d474c8..b5121cc7 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -122,6 +122,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index cfbb3bbf..7044c7aa 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -159,6 +159,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 092e9c7a..e84acbef 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -389,6 +389,7 @@ func main() { - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 9adb0ee3..27b7403e 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -177,6 +177,7 @@ func main() { - API key - Client session token - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index be8d25b6..d585f309 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -186,6 +186,7 @@ func main() { - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 9072d65a..9ddac01d 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -122,6 +122,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 96e56f57..bf09b47b 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -122,6 +122,7 @@ nil - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 3b563826..a9b53b7d 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -10,6 +10,7 @@ PATCH /user_identities/update ⇒ void - API key - Personal access token +
Must also include the `seam-workspace` header in the request. ## Request Parameters diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index c7c9d21a..5cbd0328 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -34,6 +34,9 @@ {{#each authMethods}} - {{this}} +{{#if (eq this 'Personal access token')}} +
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} +{{/if}} {{/each}} {{/if}} diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index fc1f5faa..edaae108 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -2,6 +2,7 @@ import type { CodeSampleSdk, Endpoint, SeamAuthMethod, + SeamWorkspaceScope, } from '@seamapi/blueprint' const supportedSdks: CodeSampleSdk[] = [ @@ -18,6 +19,7 @@ export interface ApiEndpointLayoutContext { title: string path: string authMethods: AuthMethodDisplayName[] + workspaceScope: SeamWorkspaceScope request: { preferredMethod: string parameters: Array<{ @@ -73,6 +75,7 @@ export function setEndpointLayoutContext( file.description = endpoint.description file.title = endpoint.title file.path = endpoint.path + file.workspaceScope = endpoint.workspaceScope file.authMethods = endpoint.authMethods .filter(