diff --git a/docs/api/_report.md b/docs/api/_report.md index 327adc94d..57f473354 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -22,7 +22,6 @@ - `/noise_sensors/noise_thresholds` - `/noise_sensors/simulate` - `/webhooks` -- `/workspaces` ### Endpoints diff --git a/docs/api/workspaces/README.md b/docs/api/workspaces/README.md new file mode 100644 index 000000000..a4ac545c8 --- /dev/null +++ b/docs/api/workspaces/README.md @@ -0,0 +1,83 @@ +# Workspaces + +## `workspace` + +### `company_name` + +Format: `String` + +--- + +### `connect_partner_name` + +{% hint style="warning" %} +**Deprecated**. use company_name +{% endhint %} + +Format: `String` + +--- + +### `connect_webview_customization` + +Format: `Object` + +
+ +inviter_logo_url Format: String +
+ +
+ +logo_shape Format: Enum + +Possible enum values: +- `circle` +- `square` +
+ +
+ +primary_button_color Format: String +
+ +
+ +primary_button_text_color Format: String +
+ +
+ +success_message Format: String +
+ +--- + +### `is_sandbox` + +Format: `Boolean` + +--- + +### `is_suspended` + +Format: `Boolean` + +True if a sandbox workspace has not been accessed in 14 days + +--- + +### `name` + +Format: `String` + +--- + +### `workspace_id` + +Format: `UUID` + +--- + +## Endpoints + diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 4b9238aaa..90127fd71 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -80,3 +80,8 @@ title: Enrollment Automations resources: - enrollment_automation + +/workspaces: + title: Workspaces + resources: + - workspace diff --git a/src/lib/reference.ts b/src/lib/reference.ts index adae39a57..609314bf4 100644 --- a/src/lib/reference.ts +++ b/src/lib/reference.ts @@ -57,7 +57,8 @@ export const reference = ( !route.path.startsWith('/acs') && !route.path.startsWith('/thermostats') && !route.path.startsWith('/phones') && - !route.path.startsWith('/user_identities') + !route.path.startsWith('/user_identities') && + !route.path.startsWith('/workspaces') ) { continue }