From 0af038bddd9c1b134505caf40698f1bcbd4477af Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Mon, 22 Dec 2025 16:19:25 +0100 Subject: [PATCH] docs: group enumerated values by property in API docs (#21372) Fixes #13840 --- docs/reference/api/agents.md | 20 +- docs/reference/api/builds.md | 138 +- docs/reference/api/enterprise.md | 93 +- docs/reference/api/insights.md | 7 +- docs/reference/api/members.md | 325 +---- docs/reference/api/notifications.md | 7 +- docs/reference/api/organizations.md | 35 +- docs/reference/api/provisioning.md | 32 +- docs/reference/api/schemas.md | 1205 +++++------------ docs/reference/api/templates.md | 208 +-- docs/reference/api/users.md | 55 +- scripts/apidocgen/markdown-template/main.dot | 35 +- .../markdown-template/parameters.def | 5 +- .../apidocgen/markdown-template/responses.def | 5 +- 14 files changed, 506 insertions(+), 1664 deletions(-) diff --git a/docs/reference/api/agents.md b/docs/reference/api/agents.md index 6f88f47039..06c91b9a7a 100644 --- a/docs/reference/api/agents.md +++ b/docs/reference/api/agents.md @@ -1134,13 +1134,9 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|----------|---------| -| `level` | `trace` | -| `level` | `debug` | -| `level` | `info` | -| `level` | `warn` | -| `level` | `error` | +| Property | Value(s) | +|----------|-------------------------------------------| +| `level` | `debug`, `error`, `info`, `trace`, `warn` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1230,12 +1226,8 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|----------|---------| -| `level` | `trace` | -| `level` | `debug` | -| `level` | `info` | -| `level` | `warn` | -| `level` | `error` | +| Property | Value(s) | +|----------|-------------------------------------------| +| `level` | `debug`, `error`, `info`, `trace`, `warn` | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/builds.md b/docs/reference/api/builds.md index dd7323886e..ff0d49e0c9 100644 --- a/docs/reference/api/builds.md +++ b/docs/reference/api/builds.md @@ -504,10 +504,9 @@ curl -X PATCH http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/c #### Enumerated Values -| Parameter | Value | -|-----------------|-----------| -| `expect_status` | `running` | -| `expect_status` | `pending` | +| Parameter | Value(s) | +|-----------------|----------------------| +| `expect_status` | `pending`, `running` | ### Example responses @@ -595,15 +594,10 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|----------------------| -| `log_level` | `trace` | -| `log_level` | `debug` | -| `log_level` | `info` | -| `log_level` | `warn` | -| `log_level` | `error` | -| `log_source` | `provisioner_daemon` | -| `log_source` | `provisioner` | +| Property | Value(s) | +|--------------|-------------------------------------------| +| `log_level` | `debug`, `error`, `info`, `trace`, `warn` | +| `log_source` | `provisioner`, `provisioner_daemon` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -936,40 +930,16 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|---------------------------|--------------------| -| `health` | `disabled` | -| `health` | `initializing` | -| `health` | `healthy` | -| `health` | `unhealthy` | -| `open_in` | `slim-window` | -| `open_in` | `tab` | -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | -| `state` | `working` | -| `state` | `idle` | -| `state` | `complete` | -| `state` | `failure` | -| `lifecycle_state` | `created` | -| `lifecycle_state` | `starting` | -| `lifecycle_state` | `start_timeout` | -| `lifecycle_state` | `start_error` | -| `lifecycle_state` | `ready` | -| `lifecycle_state` | `shutting_down` | -| `lifecycle_state` | `shutdown_timeout` | -| `lifecycle_state` | `shutdown_error` | -| `lifecycle_state` | `off` | -| `startup_script_behavior` | `blocking` | -| `startup_script_behavior` | `non-blocking` | -| `status` | `connecting` | -| `status` | `connected` | -| `status` | `disconnected` | -| `status` | `timeout` | -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | +| Property | Value(s) | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------| +| `health` | `disabled`, `healthy`, `initializing`, `unhealthy` | +| `open_in` | `slim-window`, `tab` | +| `sharing_level` | `authenticated`, `organization`, `owner`, `public` | +| `state` | `complete`, `failure`, `idle`, `working` | +| `lifecycle_state` | `created`, `off`, `ready`, `shutdown_error`, `shutdown_timeout`, `shutting_down`, `start_error`, `start_timeout`, `starting` | +| `startup_script_behavior` | `blocking`, `non-blocking` | +| `status` | `connected`, `connecting`, `disconnected`, `timeout` | +| `workspace_transition` | `delete`, `start`, `stop` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1695,66 +1665,20 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|---------------------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `type` | `template_version_import` | -| `type` | `workspace_build` | -| `type` | `template_version_dry_run` | -| `reason` | `initiator` | -| `reason` | `autostart` | -| `reason` | `autostop` | -| `health` | `disabled` | -| `health` | `initializing` | -| `health` | `healthy` | -| `health` | `unhealthy` | -| `open_in` | `slim-window` | -| `open_in` | `tab` | -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | -| `state` | `working` | -| `state` | `idle` | -| `state` | `complete` | -| `state` | `failure` | -| `lifecycle_state` | `created` | -| `lifecycle_state` | `starting` | -| `lifecycle_state` | `start_timeout` | -| `lifecycle_state` | `start_error` | -| `lifecycle_state` | `ready` | -| `lifecycle_state` | `shutting_down` | -| `lifecycle_state` | `shutdown_timeout` | -| `lifecycle_state` | `shutdown_error` | -| `lifecycle_state` | `off` | -| `startup_script_behavior` | `blocking` | -| `startup_script_behavior` | `non-blocking` | -| `status` | `connecting` | -| `status` | `connected` | -| `status` | `disconnected` | -| `status` | `timeout` | -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | -| `status` | `pending` | -| `status` | `starting` | -| `status` | `running` | -| `status` | `stopping` | -| `status` | `stopped` | -| `status` | `failed` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `deleting` | -| `status` | `deleted` | -| `transition` | `start` | -| `transition` | `stop` | -| `transition` | `delete` | +| Property | Value(s) | +|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | +| `status` | `canceled`, `canceling`, `connected`, `connecting`, `deleted`, `deleting`, `disconnected`, `failed`, `pending`, `running`, `starting`, `stopped`, `stopping`, `succeeded`, `timeout` | +| `type` | `template_version_dry_run`, `template_version_import`, `workspace_build` | +| `reason` | `autostart`, `autostop`, `initiator` | +| `health` | `disabled`, `healthy`, `initializing`, `unhealthy` | +| `open_in` | `slim-window`, `tab` | +| `sharing_level` | `authenticated`, `organization`, `owner`, `public` | +| `state` | `complete`, `failure`, `idle`, `working` | +| `lifecycle_state` | `created`, `off`, `ready`, `shutdown_error`, `shutdown_timeout`, `shutting_down`, `start_error`, `start_timeout`, `starting` | +| `startup_script_behavior` | `blocking`, `non-blocking` | +| `workspace_transition` | `delete`, `start`, `stop` | +| `transition` | `delete`, `start`, `stop` | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/enterprise.md b/docs/reference/api/enterprise.md index 0f39e4e305..8590e4182c 100644 --- a/docs/reference/api/enterprise.md +++ b/docs/reference/api/enterprise.md @@ -462,18 +462,11 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|-------------| -| `login_type` | `` | -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `login_type` | `none` | -| `status` | `active` | -| `status` | `suspended` | -| `source` | `user` | -| `source` | `oidc` | +| Property | Value(s) | +|--------------|---------------------------------------------------| +| `login_type` | ``, `github`, `none`, `oidc`, `password`, `token` | +| `status` | `active`, `suspended` | +| `source` | `oidc`, `user` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1272,9 +1265,9 @@ curl -X GET http://coder-server:8080/api/v2/oauth2/authorize?client_id=string&st #### Enumerated Values -| Parameter | Value | -|-----------------|--------| -| `response_type` | `code` | +| Parameter | Value(s) | +|-----------------|----------| +| `response_type` | `code` | ### Responses @@ -1308,9 +1301,9 @@ curl -X POST http://coder-server:8080/api/v2/oauth2/authorize?client_id=string&s #### Enumerated Values -| Parameter | Value | -|-----------------|--------| -| `response_type` | `code` | +| Parameter | Value(s) | +|-----------------|----------| +| `response_type` | `code` | ### Responses @@ -1669,10 +1662,9 @@ grant_type: authorization_code #### Enumerated Values -| Parameter | Value | -|----------------|----------------------| -| `» grant_type` | `authorization_code` | -| `» grant_type` | `refresh_token` | +| Parameter | Value(s) | +|----------------|---------------------------------------| +| `» grant_type` | `authorization_code`, `refresh_token` | ### Example responses @@ -1813,18 +1805,11 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|-------------| -| `login_type` | `` | -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `login_type` | `none` | -| `status` | `active` | -| `status` | `suspended` | -| `source` | `user` | -| `source` | `oidc` | +| Property | Value(s) | +|--------------|---------------------------------------------------| +| `login_type` | ``, `github`, `none`, `oidc`, `password`, `token` | +| `status` | `active`, `suspended` | +| `source` | `oidc`, `user` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2245,17 +2230,9 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `status` | `offline` | -| `status` | `idle` | -| `status` | `busy` | +| Property | Value(s) | +|----------|-------------------------------------------------------------------------------------------------| +| `status` | `busy`, `canceled`, `canceling`, `failed`, `idle`, `offline`, `pending`, `running`, `succeeded` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3860,18 +3837,11 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|-------------| -| `login_type` | `` | -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `login_type` | `none` | -| `status` | `active` | -| `status` | `suspended` | -| `source` | `user` | -| `source` | `oidc` | +| Property | Value(s) | +|--------------|---------------------------------------------------| +| `login_type` | ``, `github`, `none`, `oidc`, `password`, `token` | +| `status` | `active`, `suspended` | +| `source` | `oidc`, `user` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -4171,12 +4141,9 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|----------|----------------| -| `status` | `ok` | -| `status` | `unreachable` | -| `status` | `unhealthy` | -| `status` | `unregistered` | +| Property | Value(s) | +|----------|--------------------------------------------------| +| `status` | `ok`, `unhealthy`, `unreachable`, `unregistered` | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/insights.md b/docs/reference/api/insights.md index b8fcdbbb1e..62bdf0541a 100644 --- a/docs/reference/api/insights.md +++ b/docs/reference/api/insights.md @@ -67,10 +67,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0 #### Enumerated Values -| Parameter | Value | -|------------|--------| -| `interval` | `week` | -| `interval` | `day` | +| Parameter | Value(s) | +|------------|---------------| +| `interval` | `day`, `week` | ### Example responses diff --git a/docs/reference/api/members.md b/docs/reference/api/members.md index a2251a59ba..e05399e84d 100644 --- a/docs/reference/api/members.md +++ b/docs/reference/api/members.md @@ -172,67 +172,10 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `share` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `aibridge_interception` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `task` | -| `resource_type` | `template` | -| `resource_type` | `usage_event` | -| `resource_type` | `user` | -| `resource_type` | `user_secret` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +| Property | Value(s) | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `action` | `application_connect`, `assign`, `create`, `create_agent`, `delete`, `delete_agent`, `read`, `read_personal`, `share`, `ssh`, `start`, `stop`, `unassign`, `update`, `update_personal`, `use`, `view_insights` | +| `resource_type` | `*`, `aibridge_interception`, `api_key`, `assign_org_role`, `assign_role`, `audit_log`, `connection_log`, `crypto_key`, `debug_info`, `deployment_config`, `deployment_stats`, `file`, `group`, `group_member`, `idpsync_settings`, `inbox_notification`, `license`, `notification_message`, `notification_preference`, `notification_template`, `oauth2_app`, `oauth2_app_code_token`, `oauth2_app_secret`, `organization`, `organization_member`, `prebuilt_workspace`, `provisioner_daemon`, `provisioner_jobs`, `replicas`, `system`, `tailnet_coordinator`, `task`, `template`, `usage_event`, `user`, `user_secret`, `webpush_subscription`, `workspace`, `workspace_agent_devcontainers`, `workspace_agent_resource_monitor`, `workspace_dormant`, `workspace_proxy` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -362,67 +305,10 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `share` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `aibridge_interception` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `task` | -| `resource_type` | `template` | -| `resource_type` | `usage_event` | -| `resource_type` | `user` | -| `resource_type` | `user_secret` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +| Property | Value(s) | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `action` | `application_connect`, `assign`, `create`, `create_agent`, `delete`, `delete_agent`, `read`, `read_personal`, `share`, `ssh`, `start`, `stop`, `unassign`, `update`, `update_personal`, `use`, `view_insights` | +| `resource_type` | `*`, `aibridge_interception`, `api_key`, `assign_org_role`, `assign_role`, `audit_log`, `connection_log`, `crypto_key`, `debug_info`, `deployment_config`, `deployment_stats`, `file`, `group`, `group_member`, `idpsync_settings`, `inbox_notification`, `license`, `notification_message`, `notification_preference`, `notification_template`, `oauth2_app`, `oauth2_app_code_token`, `oauth2_app_secret`, `organization`, `organization_member`, `prebuilt_workspace`, `provisioner_daemon`, `provisioner_jobs`, `replicas`, `system`, `tailnet_coordinator`, `task`, `template`, `usage_event`, `user`, `user_secret`, `webpush_subscription`, `workspace`, `workspace_agent_devcontainers`, `workspace_agent_resource_monitor`, `workspace_dormant`, `workspace_proxy` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -552,67 +438,10 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `share` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `aibridge_interception` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `task` | -| `resource_type` | `template` | -| `resource_type` | `usage_event` | -| `resource_type` | `user` | -| `resource_type` | `user_secret` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +| Property | Value(s) | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `action` | `application_connect`, `assign`, `create`, `create_agent`, `delete`, `delete_agent`, `read`, `read_personal`, `share`, `ssh`, `start`, `stop`, `unassign`, `update`, `update_personal`, `use`, `view_insights` | +| `resource_type` | `*`, `aibridge_interception`, `api_key`, `assign_org_role`, `assign_role`, `audit_log`, `connection_log`, `crypto_key`, `debug_info`, `deployment_config`, `deployment_stats`, `file`, `group`, `group_member`, `idpsync_settings`, `inbox_notification`, `license`, `notification_message`, `notification_preference`, `notification_template`, `oauth2_app`, `oauth2_app_code_token`, `oauth2_app_secret`, `organization`, `organization_member`, `prebuilt_workspace`, `provisioner_daemon`, `provisioner_jobs`, `replicas`, `system`, `tailnet_coordinator`, `task`, `template`, `usage_event`, `user`, `user_secret`, `webpush_subscription`, `workspace`, `workspace_agent_devcontainers`, `workspace_agent_resource_monitor`, `workspace_dormant`, `workspace_proxy` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -704,67 +533,10 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `share` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `aibridge_interception` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `task` | -| `resource_type` | `template` | -| `resource_type` | `usage_event` | -| `resource_type` | `user` | -| `resource_type` | `user_secret` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +| Property | Value(s) | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `action` | `application_connect`, `assign`, `create`, `create_agent`, `delete`, `delete_agent`, `read`, `read_personal`, `share`, `ssh`, `start`, `stop`, `unassign`, `update`, `update_personal`, `use`, `view_insights` | +| `resource_type` | `*`, `aibridge_interception`, `api_key`, `assign_org_role`, `assign_role`, `audit_log`, `connection_log`, `crypto_key`, `debug_info`, `deployment_config`, `deployment_stats`, `file`, `group`, `group_member`, `idpsync_settings`, `inbox_notification`, `license`, `notification_message`, `notification_preference`, `notification_template`, `oauth2_app`, `oauth2_app_code_token`, `oauth2_app_secret`, `organization`, `organization_member`, `prebuilt_workspace`, `provisioner_daemon`, `provisioner_jobs`, `replicas`, `system`, `tailnet_coordinator`, `task`, `template`, `usage_event`, `user`, `user_secret`, `webpush_subscription`, `workspace`, `workspace_agent_devcontainers`, `workspace_agent_resource_monitor`, `workspace_dormant`, `workspace_proxy` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1078,66 +850,9 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|-----------------|------------------------------------| -| `action` | `application_connect` | -| `action` | `assign` | -| `action` | `create` | -| `action` | `create_agent` | -| `action` | `delete` | -| `action` | `delete_agent` | -| `action` | `read` | -| `action` | `read_personal` | -| `action` | `ssh` | -| `action` | `share` | -| `action` | `unassign` | -| `action` | `update` | -| `action` | `update_personal` | -| `action` | `use` | -| `action` | `view_insights` | -| `action` | `start` | -| `action` | `stop` | -| `resource_type` | `*` | -| `resource_type` | `aibridge_interception` | -| `resource_type` | `api_key` | -| `resource_type` | `assign_org_role` | -| `resource_type` | `assign_role` | -| `resource_type` | `audit_log` | -| `resource_type` | `connection_log` | -| `resource_type` | `crypto_key` | -| `resource_type` | `debug_info` | -| `resource_type` | `deployment_config` | -| `resource_type` | `deployment_stats` | -| `resource_type` | `file` | -| `resource_type` | `group` | -| `resource_type` | `group_member` | -| `resource_type` | `idpsync_settings` | -| `resource_type` | `inbox_notification` | -| `resource_type` | `license` | -| `resource_type` | `notification_message` | -| `resource_type` | `notification_preference` | -| `resource_type` | `notification_template` | -| `resource_type` | `oauth2_app` | -| `resource_type` | `oauth2_app_code_token` | -| `resource_type` | `oauth2_app_secret` | -| `resource_type` | `organization` | -| `resource_type` | `organization_member` | -| `resource_type` | `prebuilt_workspace` | -| `resource_type` | `provisioner_daemon` | -| `resource_type` | `provisioner_jobs` | -| `resource_type` | `replicas` | -| `resource_type` | `system` | -| `resource_type` | `tailnet_coordinator` | -| `resource_type` | `task` | -| `resource_type` | `template` | -| `resource_type` | `usage_event` | -| `resource_type` | `user` | -| `resource_type` | `user_secret` | -| `resource_type` | `webpush_subscription` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_agent_devcontainers` | -| `resource_type` | `workspace_agent_resource_monitor` | -| `resource_type` | `workspace_dormant` | -| `resource_type` | `workspace_proxy` | +| Property | Value(s) | +|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `action` | `application_connect`, `assign`, `create`, `create_agent`, `delete`, `delete_agent`, `read`, `read_personal`, `share`, `ssh`, `start`, `stop`, `unassign`, `update`, `update_personal`, `use`, `view_insights` | +| `resource_type` | `*`, `aibridge_interception`, `api_key`, `assign_org_role`, `assign_role`, `audit_log`, `connection_log`, `crypto_key`, `debug_info`, `deployment_config`, `deployment_stats`, `file`, `group`, `group_member`, `idpsync_settings`, `inbox_notification`, `license`, `notification_message`, `notification_preference`, `notification_template`, `oauth2_app`, `oauth2_app_code_token`, `oauth2_app_secret`, `organization`, `organization_member`, `prebuilt_workspace`, `provisioner_daemon`, `provisioner_jobs`, `replicas`, `system`, `tailnet_coordinator`, `task`, `template`, `usage_event`, `user`, `user_secret`, `webpush_subscription`, `workspace`, `workspace_agent_devcontainers`, `workspace_agent_resource_monitor`, `workspace_dormant`, `workspace_proxy` | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/notifications.md b/docs/reference/api/notifications.md index df94b83c16..21cbc68876 100644 --- a/docs/reference/api/notifications.md +++ b/docs/reference/api/notifications.md @@ -210,10 +210,9 @@ curl -X GET http://coder-server:8080/api/v2/notifications/inbox/watch \ #### Enumerated Values -| Parameter | Value | -|-----------|-------------| -| `format` | `plaintext` | -| `format` | `markdown` | +| Parameter | Value(s) | +|-----------|-------------------------| +| `format` | `markdown`, `plaintext` | ### Example responses diff --git a/docs/reference/api/organizations.md b/docs/reference/api/organizations.md index 36fdab0208..2c37feefff 100644 --- a/docs/reference/api/organizations.md +++ b/docs/reference/api/organizations.md @@ -283,21 +283,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi #### Enumerated Values -| Parameter | Value | -|-----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `status` | `unknown` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | +| Parameter | Value(s) | +|-----------|---------------------------------------------------------------------------------| +| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded`, `unknown` | ### Example responses @@ -396,18 +384,11 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `type` | `template_version_import` | -| `type` | `workspace_build` | -| `type` | `template_version_dry_run` | +| Property | Value(s) | +|--------------|--------------------------------------------------------------------------| +| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | +| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded` | +| `type` | `template_version_dry_run`, `template_version_import`, `workspace_build` | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/provisioning.md b/docs/reference/api/provisioning.md index 1d910e4bc0..9581af2758 100644 --- a/docs/reference/api/provisioning.md +++ b/docs/reference/api/provisioning.md @@ -25,21 +25,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi #### Enumerated Values -| Parameter | Value | -|-----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `status` | `unknown` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | +| Parameter | Value(s) | +|-----------|---------------------------------------------------------------------------------| +| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded`, `unknown` | ### Example responses @@ -119,16 +107,8 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `status` | `offline` | -| `status` | `idle` | -| `status` | `busy` | +| Property | Value(s) | +|----------|-------------------------------------------------------------------------------------------------| +| `status` | `busy`, `canceled`, `canceling`, `failed`, `idle`, `offline`, `pending`, `running`, `succeeded` | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md index 385d700637..6929f4bdb6 100644 --- a/docs/reference/api/schemas.md +++ b/docs/reference/api/schemas.md @@ -208,7 +208,7 @@ #### Enumerated Values -| Value | +| Value(s) | |--------------------| | `prebuild_claimed` | @@ -782,14 +782,10 @@ #### Enumerated Values -| Property | Value | -|--------------|-----------------------| -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `scope` | `all` | -| `scope` | `application_connect` | +| Property | Value(s) | +|--------------|---------------------------------------| +| `login_type` | `github`, `oidc`, `password`, `token` | +| `scope` | `all`, `application_connect` | ## codersdk.APIKeyScope @@ -801,204 +797,9 @@ #### Enumerated Values -| Value | -|-------------------------------------------| -| `all` | -| `application_connect` | -| `aibridge_interception:*` | -| `aibridge_interception:create` | -| `aibridge_interception:read` | -| `aibridge_interception:update` | -| `api_key:*` | -| `api_key:create` | -| `api_key:delete` | -| `api_key:read` | -| `api_key:update` | -| `assign_org_role:*` | -| `assign_org_role:assign` | -| `assign_org_role:create` | -| `assign_org_role:delete` | -| `assign_org_role:read` | -| `assign_org_role:unassign` | -| `assign_org_role:update` | -| `assign_role:*` | -| `assign_role:assign` | -| `assign_role:read` | -| `assign_role:unassign` | -| `audit_log:*` | -| `audit_log:create` | -| `audit_log:read` | -| `coder:all` | -| `coder:apikeys.manage_self` | -| `coder:application_connect` | -| `coder:templates.author` | -| `coder:templates.build` | -| `coder:workspaces.access` | -| `coder:workspaces.create` | -| `coder:workspaces.delete` | -| `coder:workspaces.operate` | -| `connection_log:*` | -| `connection_log:read` | -| `connection_log:update` | -| `crypto_key:*` | -| `crypto_key:create` | -| `crypto_key:delete` | -| `crypto_key:read` | -| `crypto_key:update` | -| `debug_info:*` | -| `debug_info:read` | -| `deployment_config:*` | -| `deployment_config:read` | -| `deployment_config:update` | -| `deployment_stats:*` | -| `deployment_stats:read` | -| `file:*` | -| `file:create` | -| `file:read` | -| `group:*` | -| `group:create` | -| `group:delete` | -| `group:read` | -| `group:update` | -| `group_member:*` | -| `group_member:read` | -| `idpsync_settings:*` | -| `idpsync_settings:read` | -| `idpsync_settings:update` | -| `inbox_notification:*` | -| `inbox_notification:create` | -| `inbox_notification:read` | -| `inbox_notification:update` | -| `license:*` | -| `license:create` | -| `license:delete` | -| `license:read` | -| `notification_message:*` | -| `notification_message:create` | -| `notification_message:delete` | -| `notification_message:read` | -| `notification_message:update` | -| `notification_preference:*` | -| `notification_preference:read` | -| `notification_preference:update` | -| `notification_template:*` | -| `notification_template:read` | -| `notification_template:update` | -| `oauth2_app:*` | -| `oauth2_app:create` | -| `oauth2_app:delete` | -| `oauth2_app:read` | -| `oauth2_app:update` | -| `oauth2_app_code_token:*` | -| `oauth2_app_code_token:create` | -| `oauth2_app_code_token:delete` | -| `oauth2_app_code_token:read` | -| `oauth2_app_secret:*` | -| `oauth2_app_secret:create` | -| `oauth2_app_secret:delete` | -| `oauth2_app_secret:read` | -| `oauth2_app_secret:update` | -| `organization:*` | -| `organization:create` | -| `organization:delete` | -| `organization:read` | -| `organization:update` | -| `organization_member:*` | -| `organization_member:create` | -| `organization_member:delete` | -| `organization_member:read` | -| `organization_member:update` | -| `prebuilt_workspace:*` | -| `prebuilt_workspace:delete` | -| `prebuilt_workspace:update` | -| `provisioner_daemon:*` | -| `provisioner_daemon:create` | -| `provisioner_daemon:delete` | -| `provisioner_daemon:read` | -| `provisioner_daemon:update` | -| `provisioner_jobs:*` | -| `provisioner_jobs:create` | -| `provisioner_jobs:read` | -| `provisioner_jobs:update` | -| `replicas:*` | -| `replicas:read` | -| `system:*` | -| `system:create` | -| `system:delete` | -| `system:read` | -| `system:update` | -| `tailnet_coordinator:*` | -| `tailnet_coordinator:create` | -| `tailnet_coordinator:delete` | -| `tailnet_coordinator:read` | -| `tailnet_coordinator:update` | -| `task:*` | -| `task:create` | -| `task:delete` | -| `task:read` | -| `task:update` | -| `template:*` | -| `template:create` | -| `template:delete` | -| `template:read` | -| `template:update` | -| `template:use` | -| `template:view_insights` | -| `usage_event:*` | -| `usage_event:create` | -| `usage_event:read` | -| `usage_event:update` | -| `user:*` | -| `user:create` | -| `user:delete` | -| `user:read` | -| `user:read_personal` | -| `user:update` | -| `user:update_personal` | -| `user_secret:*` | -| `user_secret:create` | -| `user_secret:delete` | -| `user_secret:read` | -| `user_secret:update` | -| `webpush_subscription:*` | -| `webpush_subscription:create` | -| `webpush_subscription:delete` | -| `webpush_subscription:read` | -| `workspace:*` | -| `workspace:application_connect` | -| `workspace:create` | -| `workspace:create_agent` | -| `workspace:delete` | -| `workspace:delete_agent` | -| `workspace:read` | -| `workspace:share` | -| `workspace:ssh` | -| `workspace:start` | -| `workspace:stop` | -| `workspace:update` | -| `workspace_agent_devcontainers:*` | -| `workspace_agent_devcontainers:create` | -| `workspace_agent_resource_monitor:*` | -| `workspace_agent_resource_monitor:create` | -| `workspace_agent_resource_monitor:read` | -| `workspace_agent_resource_monitor:update` | -| `workspace_dormant:*` | -| `workspace_dormant:application_connect` | -| `workspace_dormant:create` | -| `workspace_dormant:create_agent` | -| `workspace_dormant:delete` | -| `workspace_dormant:delete_agent` | -| `workspace_dormant:read` | -| `workspace_dormant:share` | -| `workspace_dormant:ssh` | -| `workspace_dormant:start` | -| `workspace_dormant:stop` | -| `workspace_dormant:update` | -| `workspace_proxy:*` | -| `workspace_proxy:create` | -| `workspace_proxy:delete` | -| `workspace_proxy:read` | -| `workspace_proxy:update` | +| Value(s) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `aibridge_interception:*`, `aibridge_interception:create`, `aibridge_interception:read`, `aibridge_interception:update`, `all`, `api_key:*`, `api_key:create`, `api_key:delete`, `api_key:read`, `api_key:update`, `application_connect`, `assign_org_role:*`, `assign_org_role:assign`, `assign_org_role:create`, `assign_org_role:delete`, `assign_org_role:read`, `assign_org_role:unassign`, `assign_org_role:update`, `assign_role:*`, `assign_role:assign`, `assign_role:read`, `assign_role:unassign`, `audit_log:*`, `audit_log:create`, `audit_log:read`, `coder:all`, `coder:apikeys.manage_self`, `coder:application_connect`, `coder:templates.author`, `coder:templates.build`, `coder:workspaces.access`, `coder:workspaces.create`, `coder:workspaces.delete`, `coder:workspaces.operate`, `connection_log:*`, `connection_log:read`, `connection_log:update`, `crypto_key:*`, `crypto_key:create`, `crypto_key:delete`, `crypto_key:read`, `crypto_key:update`, `debug_info:*`, `debug_info:read`, `deployment_config:*`, `deployment_config:read`, `deployment_config:update`, `deployment_stats:*`, `deployment_stats:read`, `file:*`, `file:create`, `file:read`, `group:*`, `group:create`, `group:delete`, `group:read`, `group:update`, `group_member:*`, `group_member:read`, `idpsync_settings:*`, `idpsync_settings:read`, `idpsync_settings:update`, `inbox_notification:*`, `inbox_notification:create`, `inbox_notification:read`, `inbox_notification:update`, `license:*`, `license:create`, `license:delete`, `license:read`, `notification_message:*`, `notification_message:create`, `notification_message:delete`, `notification_message:read`, `notification_message:update`, `notification_preference:*`, `notification_preference:read`, `notification_preference:update`, `notification_template:*`, `notification_template:read`, `notification_template:update`, `oauth2_app:*`, `oauth2_app:create`, `oauth2_app:delete`, `oauth2_app:read`, `oauth2_app:update`, `oauth2_app_code_token:*`, `oauth2_app_code_token:create`, `oauth2_app_code_token:delete`, `oauth2_app_code_token:read`, `oauth2_app_secret:*`, `oauth2_app_secret:create`, `oauth2_app_secret:delete`, `oauth2_app_secret:read`, `oauth2_app_secret:update`, `organization:*`, `organization:create`, `organization:delete`, `organization:read`, `organization:update`, `organization_member:*`, `organization_member:create`, `organization_member:delete`, `organization_member:read`, `organization_member:update`, `prebuilt_workspace:*`, `prebuilt_workspace:delete`, `prebuilt_workspace:update`, `provisioner_daemon:*`, `provisioner_daemon:create`, `provisioner_daemon:delete`, `provisioner_daemon:read`, `provisioner_daemon:update`, `provisioner_jobs:*`, `provisioner_jobs:create`, `provisioner_jobs:read`, `provisioner_jobs:update`, `replicas:*`, `replicas:read`, `system:*`, `system:create`, `system:delete`, `system:read`, `system:update`, `tailnet_coordinator:*`, `tailnet_coordinator:create`, `tailnet_coordinator:delete`, `tailnet_coordinator:read`, `tailnet_coordinator:update`, `task:*`, `task:create`, `task:delete`, `task:read`, `task:update`, `template:*`, `template:create`, `template:delete`, `template:read`, `template:update`, `template:use`, `template:view_insights`, `usage_event:*`, `usage_event:create`, `usage_event:read`, `usage_event:update`, `user:*`, `user:create`, `user:delete`, `user:read`, `user:read_personal`, `user:update`, `user:update_personal`, `user_secret:*`, `user_secret:create`, `user_secret:delete`, `user_secret:read`, `user_secret:update`, `webpush_subscription:*`, `webpush_subscription:create`, `webpush_subscription:delete`, `webpush_subscription:read`, `workspace:*`, `workspace:application_connect`, `workspace:create`, `workspace:create_agent`, `workspace:delete`, `workspace:delete_agent`, `workspace:read`, `workspace:share`, `workspace:ssh`, `workspace:start`, `workspace:stop`, `workspace:update`, `workspace_agent_devcontainers:*`, `workspace_agent_devcontainers:create`, `workspace_agent_resource_monitor:*`, `workspace_agent_resource_monitor:create`, `workspace_agent_resource_monitor:read`, `workspace_agent_resource_monitor:update`, `workspace_dormant:*`, `workspace_dormant:application_connect`, `workspace_dormant:create`, `workspace_dormant:create_agent`, `workspace_dormant:delete`, `workspace_dormant:delete_agent`, `workspace_dormant:read`, `workspace_dormant:share`, `workspace_dormant:ssh`, `workspace_dormant:start`, `workspace_dormant:stop`, `workspace_dormant:update`, `workspace_proxy:*`, `workspace_proxy:create`, `workspace_proxy:delete`, `workspace_proxy:read`, `workspace_proxy:update` | ## codersdk.AddLicenseRequest @@ -1074,11 +875,9 @@ #### Enumerated Values -| Value | -|--------------| -| `envbox` | -| `envbuilder` | -| `exectrace` | +| Value(s) | +|-------------------------------------| +| `envbox`, `envbuilder`, `exectrace` | ## codersdk.AppHostResponse @@ -1213,21 +1012,9 @@ #### Enumerated Values -| Value | -|--------------------------| -| `create` | -| `write` | -| `delete` | -| `start` | -| `stop` | -| `login` | -| `logout` | -| `register` | -| `request_password_reset` | -| `connect` | -| `disconnect` | -| `open` | -| `close` | +| Value(s) | +|-------------------------------------------------------------------------------------------------------------------------------------------------| +| `close`, `connect`, `create`, `delete`, `disconnect`, `login`, `logout`, `open`, `register`, `request_password_reset`, `start`, `stop`, `write` | ## codersdk.AuditDiff @@ -1503,12 +1290,9 @@ AuthorizationCheck is used to check if the currently authenticated user (or the #### Enumerated Values -| Property | Value | -|----------|----------| -| `action` | `create` | -| `action` | `read` | -| `action` | `update` | -| `action` | `delete` | +| Property | Value(s) | +|----------|--------------------------------------| +| `action` | `create`, `delete`, `read`, `update` | ## codersdk.AuthorizationObject @@ -1595,10 +1379,9 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in #### Enumerated Values -| Value | -|----------| -| `always` | -| `never` | +| Value(s) | +|-------------------| +| `always`, `never` | ## codersdk.BannerConfig @@ -1660,17 +1443,9 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in #### Enumerated Values -| Value | -|------------------------| -| `initiator` | -| `autostart` | -| `autostop` | -| `dormancy` | -| `dashboard` | -| `cli` | -| `ssh_connection` | -| `vscode_connection` | -| `jetbrains_connection` | +| Value(s) | +|-------------------------------------------------------------------------------------------------------------------------------------| +| `autostart`, `autostop`, `cli`, `dashboard`, `dormancy`, `initiator`, `jetbrains_connection`, `ssh_connection`, `vscode_connection` | ## codersdk.CORSBehavior @@ -1682,10 +1457,9 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in #### Enumerated Values -| Value | -|------------| -| `simple` | -| `passthru` | +| Value(s) | +|----------------------| +| `passthru`, `simple` | ## codersdk.ChangePasswordWithOneTimePasscodeRequest @@ -1934,14 +1708,9 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in #### Enumerated Values -| Value | -|--------------------| -| `ssh` | -| `vscode` | -| `jetbrains` | -| `reconnecting_pty` | -| `workspace_app` | -| `port_forwarding` | +| Value(s) | +|--------------------------------------------------------------------------------------| +| `jetbrains`, `port_forwarding`, `reconnecting_pty`, `ssh`, `vscode`, `workspace_app` | ## codersdk.ConvertLoginRequest @@ -2240,11 +2009,10 @@ This is required on creation to enable a user-flow of validating a template work #### Enumerated Values -| Property | Value | -|------------------|-------------| -| `provisioner` | `terraform` | -| `provisioner` | `echo` | -| `storage_method` | `file` | +| Property | Value(s) | +|------------------|---------------------| +| `provisioner` | `echo`, `terraform` | +| `storage_method` | `file` | ## codersdk.CreateTestAuditLogRequest @@ -2278,23 +2046,11 @@ This is required on creation to enable a user-flow of validating a template work #### Enumerated Values -| Property | Value | -|-----------------|--------------------| -| `action` | `create` | -| `action` | `write` | -| `action` | `delete` | -| `action` | `start` | -| `action` | `stop` | -| `build_reason` | `autostart` | -| `build_reason` | `autostop` | -| `build_reason` | `initiator` | -| `resource_type` | `template` | -| `resource_type` | `template_version` | -| `resource_type` | `user` | -| `resource_type` | `workspace` | -| `resource_type` | `workspace_build` | -| `resource_type` | `git_ssh_key` | -| `resource_type` | `auditable_group` | +| Property | Value(s) | +|-----------------|----------------------------------------------------------------------------------------------------------| +| `action` | `create`, `delete`, `start`, `stop`, `write` | +| `build_reason` | `autostart`, `autostop`, `initiator` | +| `resource_type` | `auditable_group`, `git_ssh_key`, `template`, `template_version`, `user`, `workspace`, `workspace_build` | ## codersdk.CreateTokenRequest @@ -2363,13 +2119,9 @@ This is required on creation to enable a user-flow of validating a template work #### Enumerated Values -| Value | -|------------------------| -| `dashboard` | -| `cli` | -| `ssh_connection` | -| `vscode_connection` | -| `jetbrains_connection` | +| Value(s) | +|-----------------------------------------------------------------------------------| +| `cli`, `dashboard`, `jetbrains_connection`, `ssh_connection`, `vscode_connection` | ## codersdk.CreateWorkspaceBuildRequest @@ -2410,17 +2162,11 @@ This is required on creation to enable a user-flow of validating a template work #### Enumerated Values -| Property | Value | -|--------------|------------------------| -| `log_level` | `debug` | -| `reason` | `dashboard` | -| `reason` | `cli` | -| `reason` | `ssh_connection` | -| `reason` | `vscode_connection` | -| `reason` | `jetbrains_connection` | -| `transition` | `start` | -| `transition` | `stop` | -| `transition` | `delete` | +| Property | Value(s) | +|--------------|-----------------------------------------------------------------------------------| +| `log_level` | `debug` | +| `reason` | `cli`, `dashboard`, `jetbrains_connection`, `ssh_connection`, `vscode_connection` | +| `transition` | `delete`, `start`, `stop` | ## codersdk.CreateWorkspaceProxyRequest @@ -2507,12 +2253,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|--------------------------| -| `workspace_apps_api_key` | -| `workspace_apps_token` | -| `oidc_convert` | -| `tailnet_resume` | +| Value(s) | +|------------------------------------------------------------------------------------| +| `oidc_convert`, `tailnet_resume`, `workspace_apps_api_key`, `workspace_apps_token` | ## codersdk.CustomNotificationContent @@ -3892,10 +3635,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|-----------| -| `error` | -| `warning` | +| Value(s) | +|--------------------| +| `error`, `warning` | ## codersdk.DisplayApp @@ -3907,13 +3649,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|--------------------------| -| `vscode` | -| `vscode_insiders` | -| `web_terminal` | -| `port_forwarding_helper` | -| `ssh_helper` | +| Value(s) | +|-------------------------------------------------------------------------------------| +| `port_forwarding_helper`, `ssh_helper`, `vscode`, `vscode_insiders`, `web_terminal` | ## codersdk.DynamicParametersRequest @@ -4031,11 +3769,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|----------------| -| `entitled` | -| `grace_period` | -| `not_entitled` | +| Value(s) | +|--------------------------------------------| +| `entitled`, `grace_period`, `not_entitled` | ## codersdk.Entitlements @@ -4103,17 +3839,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o #### Enumerated Values -| Value | -|-----------------------------| -| `example` | -| `auto-fill-parameters` | -| `notifications` | -| `workspace-usage` | -| `web-push` | -| `oauth2` | -| `mcp-server-http` | -| `workspace-sharing` | -| `terraform-directory-reuse` | +| Value(s) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `auto-fill-parameters`, `example`, `mcp-server-http`, `notifications`, `oauth2`, `terraform-directory-reuse`, `web-push`, `workspace-sharing`, `workspace-usage` | ## codersdk.ExternalAPIKeyScopes @@ -4606,10 +4334,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|--------| -| `user` | -| `oidc` | +| Value(s) | +|----------------| +| `oidc`, `user` | ## codersdk.GroupSyncSettings @@ -4760,10 +4487,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|--------| -| `day` | -| `week` | +| Value(s) | +|---------------| +| `day`, `week` | ## codersdk.InvalidatePresetsResponse @@ -4843,7 +4569,7 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | +| Value(s) | |-------------------------------| | `REQUIRED_TEMPLATE_VARIABLES` | @@ -4889,14 +4615,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | -|------------|------------| -| `icon` | `bug` | -| `icon` | `chat` | -| `icon` | `docs` | -| `icon` | `star` | -| `location` | `navbar` | -| `location` | `dropdown` | +| Property | Value(s) | +|------------|-------------------------------| +| `icon` | `bug`, `chat`, `docs`, `star` | +| `location` | `dropdown`, `navbar` | ## codersdk.ListInboxNotificationsResponse @@ -4944,13 +4666,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|---------| -| `trace` | -| `debug` | -| `info` | -| `warn` | -| `error` | +| Value(s) | +|-------------------------------------------| +| `debug`, `error`, `info`, `trace`, `warn` | ## codersdk.LogSource @@ -4962,10 +4680,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------------| -| `provisioner_daemon` | -| `provisioner` | +| Value(s) | +|-------------------------------------| +| `provisioner`, `provisioner_daemon` | ## codersdk.LoggingConfig @@ -4999,14 +4716,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|------------| -| `` | -| `password` | -| `github` | -| `oidc` | -| `token` | -| `none` | +| Value(s) | +|---------------------------------------------------| +| ``, `github`, `none`, `oidc`, `password`, `token` | ## codersdk.LoginWithPasswordRequest @@ -5910,12 +5622,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------| -| `string` | -| `number` | -| `bool` | -| `list(string)` | +| Value(s) | +|--------------------------------------------| +| `bool`, `list(string)`, `number`, `string` | ## codersdk.Organization @@ -6094,19 +5803,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------| -| `` | -| `radio` | -| `slider` | -| `input` | -| `dropdown` | -| `checkbox` | -| `switch` | -| `multi-select` | -| `tag-select` | -| `textarea` | -| `error` | +| Value(s) | +|---------------------------------------------------------------------------------------------------------------------| +| ``, `checkbox`, `dropdown`, `error`, `input`, `multi-select`, `radio`, `slider`, `switch`, `tag-select`, `textarea` | ## codersdk.PatchGroupIDPSyncConfigRequest @@ -6724,11 +6423,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | -|----------|-----------| -| `status` | `offline` | -| `status` | `idle` | -| `status` | `busy` | +| Property | Value(s) | +|----------|---------------------------| +| `status` | `busy`, `idle`, `offline` | ## codersdk.ProvisionerDaemonJob @@ -6754,14 +6451,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | +| Property | Value(s) | +|----------|----------------------------------------------------------------------| +| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded` | ## codersdk.ProvisionerDaemonStatus @@ -6773,11 +6465,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-----------| -| `offline` | -| `idle` | -| `busy` | +| Value(s) | +|---------------------------| +| `busy`, `idle`, `offline` | ## codersdk.ProvisionerJob @@ -6853,15 +6543,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | -|--------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | +| Property | Value(s) | +|--------------|----------------------------------------------------------------------| +| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | +| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded` | ## codersdk.ProvisionerJobInput @@ -6907,13 +6592,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | -|-------------|---------| -| `log_level` | `trace` | -| `log_level` | `debug` | -| `log_level` | `info` | -| `log_level` | `warn` | -| `log_level` | `error` | +| Property | Value(s) | +|-------------|-------------------------------------------| +| `log_level` | `debug`, `error`, `info`, `trace`, `warn` | ## codersdk.ProvisionerJobMetadata @@ -6951,15 +6632,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-------------| -| `pending` | -| `running` | -| `succeeded` | -| `canceling` | -| `canceled` | -| `failed` | -| `unknown` | +| Value(s) | +|---------------------------------------------------------------------------------| +| `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded`, `unknown` | ## codersdk.ProvisionerJobType @@ -6971,11 +6646,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------------------| -| `template_version_import` | -| `workspace_build` | -| `template_version_dry_run` | +| Value(s) | +|--------------------------------------------------------------------------| +| `template_version_dry_run`, `template_version_import`, `workspace_build` | ## codersdk.ProvisionerKey @@ -7086,9 +6759,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|---------| -| `debug` | +| Value(s) | +|----------| +| `debug` | ## codersdk.ProvisionerStorageMethod @@ -7100,9 +6773,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|--------| -| `file` | +| Value(s) | +|----------| +| `file` | ## codersdk.ProvisionerTiming @@ -7160,12 +6833,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------| -| `ok` | -| `unreachable` | -| `unhealthy` | -| `unregistered` | +| Value(s) | +|--------------------------------------------------| +| `ok`, `unhealthy`, `unreachable`, `unregistered` | ## codersdk.PutExtendWorkspaceRequest @@ -7209,25 +6879,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-----------------------| -| `application_connect` | -| `assign` | -| `create` | -| `create_agent` | -| `delete` | -| `delete_agent` | -| `read` | -| `read_personal` | -| `ssh` | -| `share` | -| `unassign` | -| `update` | -| `update_personal` | -| `use` | -| `view_insights` | -| `start` | -| `stop` | +| Value(s) | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `application_connect`, `assign`, `create`, `create_agent`, `delete`, `delete_agent`, `read`, `read_personal`, `share`, `ssh`, `start`, `stop`, `unassign`, `update`, `update_personal`, `use`, `view_insights` | ## codersdk.RBACResource @@ -7239,50 +6893,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|------------------------------------| -| `*` | -| `aibridge_interception` | -| `api_key` | -| `assign_org_role` | -| `assign_role` | -| `audit_log` | -| `connection_log` | -| `crypto_key` | -| `debug_info` | -| `deployment_config` | -| `deployment_stats` | -| `file` | -| `group` | -| `group_member` | -| `idpsync_settings` | -| `inbox_notification` | -| `license` | -| `notification_message` | -| `notification_preference` | -| `notification_template` | -| `oauth2_app` | -| `oauth2_app_code_token` | -| `oauth2_app_secret` | -| `organization` | -| `organization_member` | -| `prebuilt_workspace` | -| `provisioner_daemon` | -| `provisioner_jobs` | -| `replicas` | -| `system` | -| `tailnet_coordinator` | -| `task` | -| `template` | -| `usage_event` | -| `user` | -| `user_secret` | -| `webpush_subscription` | -| `workspace` | -| `workspace_agent_devcontainers` | -| `workspace_agent_resource_monitor` | -| `workspace_dormant` | -| `workspace_proxy` | +| Value(s) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `*`, `aibridge_interception`, `api_key`, `assign_org_role`, `assign_role`, `audit_log`, `connection_log`, `crypto_key`, `debug_info`, `deployment_config`, `deployment_stats`, `file`, `group`, `group_member`, `idpsync_settings`, `inbox_notification`, `license`, `notification_message`, `notification_preference`, `notification_template`, `oauth2_app`, `oauth2_app_code_token`, `oauth2_app_secret`, `organization`, `organization_member`, `prebuilt_workspace`, `provisioner_daemon`, `provisioner_jobs`, `replicas`, `system`, `tailnet_coordinator`, `task`, `template`, `usage_event`, `user`, `user_secret`, `webpush_subscription`, `workspace`, `workspace_agent_devcontainers`, `workspace_agent_resource_monitor`, `workspace_dormant`, `workspace_proxy` | ## codersdk.RateLimitConfig @@ -7336,10 +6949,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `active` | -| `status` | `suspended` | +| Property | Value(s) | +|----------|-----------------------| +| `status` | `active`, `suspended` | ## codersdk.Region @@ -7497,34 +7109,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------------------------| -| `template` | -| `template_version` | -| `user` | -| `workspace` | -| `workspace_build` | -| `git_ssh_key` | -| `api_key` | -| `group` | -| `license` | -| `convert_login` | -| `health_settings` | -| `notifications_settings` | -| `prebuilds_settings` | -| `workspace_proxy` | -| `organization` | -| `oauth2_provider_app` | -| `oauth2_provider_app_secret` | -| `custom_role` | -| `organization_member` | -| `notification_template` | -| `idp_sync_settings_organization` | -| `idp_sync_settings_group` | -| `idp_sync_settings_role` | -| `workspace_agent` | -| `workspace_app` | -| `task` | +| Value(s) | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `api_key`, `convert_login`, `custom_role`, `git_ssh_key`, `group`, `health_settings`, `idp_sync_settings_group`, `idp_sync_settings_organization`, `idp_sync_settings_role`, `license`, `notification_template`, `notifications_settings`, `oauth2_provider_app`, `oauth2_provider_app_secret`, `organization`, `organization_member`, `prebuilds_settings`, `task`, `template`, `template_version`, `user`, `workspace`, `workspace_agent`, `workspace_app`, `workspace_build`, `workspace_proxy` | ## codersdk.Response @@ -7709,11 +7296,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|---------| -| `ping` | -| `data` | -| `error` | +| Value(s) | +|-------------------------| +| `data`, `error`, `ping` | ## codersdk.SessionCountDeploymentStats @@ -7785,10 +7370,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | -|--------------|---------| -| `actor_type` | `group` | -| `actor_type` | `user` | +| Property | Value(s) | +|--------------|-----------------| +| `actor_type` | `group`, `user` | ## codersdk.SharedWorkspaceActorType @@ -7800,10 +7384,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|---------| -| `group` | -| `user` | +| Value(s) | +|-----------------| +| `group`, `user` | ## codersdk.SlimRole @@ -7986,24 +7569,10 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | -|--------------------|----------------| -| `status` | `pending` | -| `status` | `initializing` | -| `status` | `active` | -| `status` | `paused` | -| `status` | `unknown` | -| `status` | `error` | -| `workspace_status` | `pending` | -| `workspace_status` | `starting` | -| `workspace_status` | `running` | -| `workspace_status` | `stopping` | -| `workspace_status` | `stopped` | -| `workspace_status` | `failed` | -| `workspace_status` | `canceling` | -| `workspace_status` | `canceled` | -| `workspace_status` | `deleting` | -| `workspace_status` | `deleted` | +| Property | Value(s) | +|--------------------|-------------------------------------------------------------------------------------------------------------------| +| `status` | `active`, `error`, `initializing`, `paused`, `pending`, `unknown` | +| `workspace_status` | `canceled`, `canceling`, `deleted`, `deleting`, `failed`, `pending`, `running`, `starting`, `stopped`, `stopping` | ## codersdk.TaskLogEntry @@ -8035,10 +7604,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------| -| `input` | -| `output` | +| Value(s) | +|-------------------| +| `input`, `output` | ## codersdk.TaskLogsResponse @@ -8085,12 +7653,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|------------| -| `working` | -| `idle` | -| `complete` | -| `failed` | +| Value(s) | +|-----------------------------------------| +| `complete`, `failed`, `idle`, `working` | ## codersdk.TaskStateEntry @@ -8122,14 +7687,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|----------------| -| `pending` | -| `initializing` | -| `active` | -| `paused` | -| `unknown` | -| `error` | +| Value(s) | +|-------------------------------------------------------------------| +| `active`, `error`, `initializing`, `paused`, `pending`, `unknown` | ## codersdk.TasksListResponse @@ -8322,7 +7882,7 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Property | Value | +| Property | Value(s) | |---------------|-------------| | `provisioner` | `terraform` | @@ -8434,10 +7994,9 @@ Only certain features set these fields: - FeatureManagedAgentLimit| #### Enumerated Values -| Value | -|-----------| -| `builtin` | -| `app` | +| Value(s) | +|------------------| +| `app`, `builtin` | ## codersdk.TemplateAutostartRequirement @@ -8575,10 +8134,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Property | Value | -|----------|---------| -| `role` | `admin` | -| `role` | `use` | +| Property | Value(s) | +|----------|----------------| +| `role` | `admin`, `use` | ## codersdk.TemplateInsightsConfig @@ -8817,11 +8375,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Value | -|---------| -| `admin` | -| `use` | -| `` | +| Value(s) | +|--------------------| +| ``, `admin`, `use` | ## codersdk.TemplateUser @@ -8873,12 +8429,10 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Property | Value | -|----------|-------------| -| `role` | `admin` | -| `role` | `use` | -| `status` | `active` | -| `status` | `suspended` | +| Property | Value(s) | +|----------|-----------------------| +| `role` | `admin`, `use` | +| `status` | `active`, `suspended` | ## codersdk.TemplateVersion @@ -9051,25 +8605,11 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Property | Value | -|------------------------|----------------| -| `form_type` | `` | -| `form_type` | `radio` | -| `form_type` | `dropdown` | -| `form_type` | `input` | -| `form_type` | `textarea` | -| `form_type` | `slider` | -| `form_type` | `checkbox` | -| `form_type` | `switch` | -| `form_type` | `tag-select` | -| `form_type` | `multi-select` | -| `form_type` | `error` | -| `type` | `string` | -| `type` | `number` | -| `type` | `bool` | -| `type` | `list(string)` | -| `validation_monotonic` | `increasing` | -| `validation_monotonic` | `decreasing` | +| Property | Value(s) | +|------------------------|---------------------------------------------------------------------------------------------------------------------| +| `form_type` | ``, `checkbox`, `dropdown`, `error`, `input`, `multi-select`, `radio`, `slider`, `switch`, `tag-select`, `textarea` | +| `type` | `bool`, `list(string)`, `number`, `string` | +| `validation_monotonic` | `decreasing`, `increasing` | ## codersdk.TemplateVersionParameterOption @@ -9119,11 +8659,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Property | Value | -|----------|----------| -| `type` | `string` | -| `type` | `number` | -| `type` | `bool` | +| Property | Value(s) | +|----------|----------------------------| +| `type` | `bool`, `number`, `string` | ## codersdk.TemplateVersionWarning @@ -9135,7 +8673,7 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Value | +| Value(s) | |--------------------------| | `UNSUPPORTED_WORKSPACES` | @@ -9149,13 +8687,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Value | -|-------------------| -| `` | -| `ibm-plex-mono` | -| `fira-code` | -| `source-code-pro` | -| `jetbrains-mono` | +| Value(s) | +|-----------------------------------------------------------------------| +| ``, `fira-code`, `ibm-plex-mono`, `jetbrains-mono`, `source-code-pro` | ## codersdk.TimingStage @@ -9167,16 +8701,9 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Value | -|-----------| -| `init` | -| `plan` | -| `graph` | -| `apply` | -| `start` | -| `stop` | -| `cron` | -| `connect` | +| Value(s) | +|----------------------------------------------------------------------| +| `apply`, `connect`, `cron`, `graph`, `init`, `plan`, `start`, `stop` | ## codersdk.TokenConfig @@ -9657,14 +9184,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|---------------|-----------------| -| `protocol` | `http` | -| `protocol` | `https` | -| `share_level` | `owner` | -| `share_level` | `authenticated` | -| `share_level` | `organization` | -| `share_level` | `public` | +| Property | Value(s) | +|---------------|----------------------------------------------------| +| `protocol` | `http`, `https` | +| `share_level` | `authenticated`, `organization`, `owner`, `public` | ## codersdk.UsageAppName @@ -9676,12 +9199,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|--------------------| -| `vscode` | -| `jetbrains` | -| `reconnecting-pty` | -| `ssh` | +| Value(s) | +|--------------------------------------------------| +| `jetbrains`, `reconnecting-pty`, `ssh`, `vscode` | ## codersdk.UsagePeriod @@ -9749,10 +9269,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|----------|-------------| -| `status` | `active` | -| `status` | `suspended` | +| Property | Value(s) | +|----------|-----------------------| +| `status` | `active`, `suspended` | ## codersdk.UserActivity @@ -10047,11 +9566,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|-------------| -| `active` | -| `dormant` | -| `suspended` | +| Value(s) | +|----------------------------------| +| `active`, `dormant`, `suspended` | ## codersdk.UserStatusChangeCount @@ -10125,10 +9642,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|--------------| -| `increasing` | -| `decreasing` | +| Value(s) | +|----------------------------| +| `decreasing`, `increasing` | ## codersdk.VariableValue @@ -10478,10 +9994,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|---------------------|----------| -| `automatic_updates` | `always` | -| `automatic_updates` | `never` | +| Property | Value(s) | +|---------------------|-------------------| +| `automatic_updates` | `always`, `never` | ## codersdk.WorkspaceACL @@ -10846,14 +10361,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|------------| -| `running` | -| `stopped` | -| `starting` | -| `stopping` | -| `deleting` | -| `error` | +| Value(s) | +|-------------------------------------------------------------------| +| `deleting`, `error`, `running`, `starting`, `stopped`, `stopping` | ## codersdk.WorkspaceAgentHealth @@ -10881,17 +10391,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|--------------------| -| `created` | -| `starting` | -| `start_timeout` | -| `start_error` | -| `ready` | -| `shutting_down` | -| `shutdown_timeout` | -| `shutdown_error` | -| `off` | +| Value(s) | +|------------------------------------------------------------------------------------------------------------------------------| +| `created`, `off`, `ready`, `shutdown_error`, `shutdown_timeout`, `shutting_down`, `start_error`, `start_timeout`, `starting` | ## codersdk.WorkspaceAgentListContainersResponse @@ -11083,14 +10585,10 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|---------------|-----------------| -| `protocol` | `http` | -| `protocol` | `https` | -| `share_level` | `owner` | -| `share_level` | `authenticated` | -| `share_level` | `organization` | -| `share_level` | `public` | +| Property | Value(s) | +|---------------|----------------------------------------------------| +| `protocol` | `http`, `https` | +| `share_level` | `authenticated`, `organization`, `owner`, `public` | ## codersdk.WorkspaceAgentPortShareLevel @@ -11102,12 +10600,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|-----------------| -| `owner` | -| `authenticated` | -| `organization` | -| `public` | +| Value(s) | +|----------------------------------------------------| +| `authenticated`, `organization`, `owner`, `public` | ## codersdk.WorkspaceAgentPortShareProtocol @@ -11119,10 +10614,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|---------| -| `http` | -| `https` | +| Value(s) | +|-----------------| +| `http`, `https` | ## codersdk.WorkspaceAgentPortShares @@ -11188,10 +10682,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|----------------| -| `blocking` | -| `non-blocking` | +| Value(s) | +|----------------------------| +| `blocking`, `non-blocking` | ## codersdk.WorkspaceAgentStatus @@ -11203,12 +10696,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|----------------| -| `connecting` | -| `connected` | -| `disconnected` | -| `timeout` | +| Value(s) | +|------------------------------------------------------| +| `connected`, `connecting`, `disconnected`, `timeout` | ## codersdk.WorkspaceApp @@ -11275,12 +10765,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|-----------------|-----------------| -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | +| Property | Value(s) | +|-----------------|----------------------------------------------------| +| `sharing_level` | `authenticated`, `organization`, `owner`, `public` | ## codersdk.WorkspaceAppHealth @@ -11292,12 +10779,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|----------------| -| `disabled` | -| `initializing` | -| `healthy` | -| `unhealthy` | +| Value(s) | +|----------------------------------------------------| +| `disabled`, `healthy`, `initializing`, `unhealthy` | ## codersdk.WorkspaceAppOpenIn @@ -11309,10 +10793,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|---------------| -| `slim-window` | -| `tab` | +| Value(s) | +|----------------------| +| `slim-window`, `tab` | ## codersdk.WorkspaceAppSharingLevel @@ -11324,12 +10807,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|-----------------| -| `owner` | -| `authenticated` | -| `organization` | -| `public` | +| Value(s) | +|----------------------------------------------------| +| `authenticated`, `organization`, `owner`, `public` | ## codersdk.WorkspaceAppStatus @@ -11373,12 +10853,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|------------| -| `working` | -| `idle` | -| `complete` | -| `failure` | +| Value(s) | +|------------------------------------------| +| `complete`, `failure`, `idle`, `working` | ## codersdk.WorkspaceBuild @@ -11623,24 +11100,11 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|--------------|-------------| -| `reason` | `initiator` | -| `reason` | `autostart` | -| `reason` | `autostop` | -| `status` | `pending` | -| `status` | `starting` | -| `status` | `running` | -| `status` | `stopping` | -| `status` | `stopped` | -| `status` | `failed` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `deleting` | -| `status` | `deleted` | -| `transition` | `start` | -| `transition` | `stop` | -| `transition` | `delete` | +| Property | Value(s) | +|--------------|-------------------------------------------------------------------------------------------------------------------| +| `reason` | `autostart`, `autostop`, `initiator` | +| `status` | `canceled`, `canceling`, `deleted`, `deleting`, `failed`, `pending`, `running`, `starting`, `stopped`, `stopping` | +| `transition` | `delete`, `start`, `stop` | ## codersdk.WorkspaceBuildParameter @@ -11804,10 +11268,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|----------|---------| -| `role` | `admin` | -| `role` | `use` | +| Property | Value(s) | +|----------|----------------| +| `role` | `admin`, `use` | ## codersdk.WorkspaceHealth @@ -12077,11 +11540,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|------------------------|----------| -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | +| Property | Value(s) | +|------------------------|---------------------------| +| `workspace_transition` | `delete`, `start`, `stop` | ## codersdk.WorkspaceResourceMetadata @@ -12111,11 +11572,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|---------| -| `admin` | -| `use` | -| `` | +| Value(s) | +|--------------------| +| ``, `admin`, `use` | ## codersdk.WorkspaceStatus @@ -12127,18 +11586,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|-------------| -| `pending` | -| `starting` | -| `running` | -| `stopping` | -| `stopped` | -| `failed` | -| `canceling` | -| `canceled` | -| `deleting` | -| `deleted` | +| Value(s) | +|-------------------------------------------------------------------------------------------------------------------| +| `canceled`, `canceling`, `deleted`, `deleting`, `failed`, `pending`, `running`, `starting`, `stopped`, `stopping` | ## codersdk.WorkspaceTransition @@ -12150,11 +11600,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Value | -|----------| -| `start` | -| `stop` | -| `delete` | +| Value(s) | +|---------------------------| +| `delete`, `start`, `stop` | ## codersdk.WorkspaceUser @@ -12180,10 +11628,9 @@ If the schedule is empty, the user will be updated to use the default schedule.| #### Enumerated Values -| Property | Value | -|----------|---------| -| `role` | `admin` | -| `role` | `use` | +| Property | Value(s) | +|----------|----------------| +| `role` | `admin`, `use` | ## codersdk.WorkspacesResponse @@ -12500,26 +11947,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Value | -|------------| -| `EUNKNOWN` | -| `EWP01` | -| `EWP02` | -| `EWP04` | -| `EDB01` | -| `EDB02` | -| `EWS01` | -| `EWS02` | -| `EWS03` | -| `EACS01` | -| `EACS02` | -| `EACS03` | -| `EACS04` | -| `EDERP01` | -| `EDERP02` | -| `EPD01` | -| `EPD02` | -| `EPD03` | +| Value(s) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `EACS01`, `EACS02`, `EACS03`, `EACS04`, `EDB01`, `EDB02`, `EDERP01`, `EDERP02`, `EPD01`, `EPD02`, `EPD03`, `EUNKNOWN`, `EWP01`, `EWP02`, `EWP04`, `EWS01`, `EWS02`, `EWS03` | ## health.Message @@ -12547,11 +11977,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Value | -|-----------| -| `ok` | -| `warning` | -| `error` | +| Value(s) | +|--------------------------| +| `error`, `ok`, `warning` | ## healthsdk.AccessURLReport @@ -12590,11 +12018,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## healthsdk.DERPHealthReport @@ -12838,11 +12264,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## healthsdk.DERPNodeReport @@ -12918,11 +12342,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## healthsdk.DERPRegionReport @@ -13028,11 +12450,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## healthsdk.DatabaseReport @@ -13071,11 +12491,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## healthsdk.HealthSection @@ -13087,14 +12505,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Value | -|----------------------| -| `DERP` | -| `AccessURL` | -| `Websocket` | -| `Database` | -| `WorkspaceProxy` | -| `ProvisionerDaemons` | +| Value(s) | +|--------------------------------------------------------------------------------------| +| `AccessURL`, `DERP`, `Database`, `ProvisionerDaemons`, `Websocket`, `WorkspaceProxy` | ## healthsdk.HealthSettings @@ -13503,11 +12916,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## healthsdk.ProvisionerDaemonsReport @@ -13580,11 +12991,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## healthsdk.ProvisionerDaemonsReportItem @@ -13706,11 +13115,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## healthsdk.WorkspaceProxyReport @@ -13773,11 +13180,9 @@ Zero means unspecified. There might be a limit, but the client need not try to r #### Enumerated Values -| Property | Value | -|------------|-----------| -| `severity` | `ok` | -| `severity` | `warning` | -| `severity` | `error` | +| Property | Value(s) | +|------------|--------------------------| +| `severity` | `error`, `ok`, `warning` | ## key.NodePublic @@ -14139,13 +13544,9 @@ None #### Enumerated Values -| Value | -|-----------| -| `` | -| `flag` | -| `env` | -| `yaml` | -| `default` | +| Value(s) | +|--------------------------------------| +| ``, `default`, `env`, `flag`, `yaml` | ## tailcfg.DERPHomeParams @@ -14365,11 +13766,9 @@ None #### Enumerated Values -| Value | -|-------------| -| `path` | -| `subdomain` | -| `terminal` | +| Value(s) | +|---------------------------------| +| `path`, `subdomain`, `terminal` | ## workspaceapps.IssueTokenRequest diff --git a/docs/reference/api/templates.md b/docs/reference/api/templates.md index 7849b79957..721fa2dada 100644 --- a/docs/reference/api/templates.md +++ b/docs/reference/api/templates.md @@ -143,15 +143,11 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Property | Value | -|------------------------|-----------------| -| `cors_behavior` | `simple` | -| `cors_behavior` | `passthru` | -| `max_port_share_level` | `owner` | -| `max_port_share_level` | `authenticated` | -| `max_port_share_level` | `organization` | -| `max_port_share_level` | `public` | -| `provisioner` | `terraform` | +| Property | Value(s) | +|------------------------|----------------------------------------------------| +| `cors_behavior` | `passthru`, `simple` | +| `max_port_share_level` | `authenticated`, `organization`, `owner`, `public` | +| `provisioner` | `terraform` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -899,15 +895,11 @@ Restarts will only happen on weekdays in this list on weeks which line up with W #### Enumerated Values -| Property | Value | -|------------------------|-----------------| -| `cors_behavior` | `simple` | -| `cors_behavior` | `passthru` | -| `max_port_share_level` | `owner` | -| `max_port_share_level` | `authenticated` | -| `max_port_share_level` | `organization` | -| `max_port_share_level` | `public` | -| `provisioner` | `terraform` | +| Property | Value(s) | +|------------------------|----------------------------------------------------| +| `cors_behavior` | `passthru`, `simple` | +| `max_port_share_level` | `authenticated`, `organization`, `owner`, `public` | +| `provisioner` | `terraform` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1438,18 +1430,11 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `type` | `template_version_import` | -| `type` | `workspace_build` | -| `type` | `template_version_dry_run` | +| Property | Value(s) | +|--------------|--------------------------------------------------------------------------| +| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | +| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded` | +| `type` | `template_version_dry_run`, `template_version_import`, `workspace_build` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -1725,18 +1710,11 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|-------------------------------| -| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | -| `status` | `pending` | -| `status` | `running` | -| `status` | `succeeded` | -| `status` | `canceling` | -| `status` | `canceled` | -| `status` | `failed` | -| `type` | `template_version_import` | -| `type` | `workspace_build` | -| `type` | `template_version_dry_run` | +| Property | Value(s) | +|--------------|--------------------------------------------------------------------------| +| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | +| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded` | +| `type` | `template_version_dry_run`, `template_version_import`, `workspace_build` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2317,15 +2295,10 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|----------------------| -| `log_level` | `trace` | -| `log_level` | `debug` | -| `log_level` | `info` | -| `log_level` | `warn` | -| `log_level` | `error` | -| `log_source` | `provisioner_daemon` | -| `log_source` | `provisioner` | +| Property | Value(s) | +|--------------|-------------------------------------------| +| `log_level` | `debug`, `error`, `info`, `trace`, `warn` | +| `log_source` | `provisioner`, `provisioner_daemon` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2649,40 +2622,16 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|---------------------------|--------------------| -| `health` | `disabled` | -| `health` | `initializing` | -| `health` | `healthy` | -| `health` | `unhealthy` | -| `open_in` | `slim-window` | -| `open_in` | `tab` | -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | -| `state` | `working` | -| `state` | `idle` | -| `state` | `complete` | -| `state` | `failure` | -| `lifecycle_state` | `created` | -| `lifecycle_state` | `starting` | -| `lifecycle_state` | `start_timeout` | -| `lifecycle_state` | `start_error` | -| `lifecycle_state` | `ready` | -| `lifecycle_state` | `shutting_down` | -| `lifecycle_state` | `shutdown_timeout` | -| `lifecycle_state` | `shutdown_error` | -| `lifecycle_state` | `off` | -| `startup_script_behavior` | `blocking` | -| `startup_script_behavior` | `non-blocking` | -| `status` | `connecting` | -| `status` | `connected` | -| `status` | `disconnected` | -| `status` | `timeout` | -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | +| Property | Value(s) | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------| +| `health` | `disabled`, `healthy`, `initializing`, `unhealthy` | +| `open_in` | `slim-window`, `tab` | +| `sharing_level` | `authenticated`, `organization`, `owner`, `public` | +| `state` | `complete`, `failure`, `idle`, `working` | +| `lifecycle_state` | `created`, `off`, `ready`, `shutdown_error`, `shutdown_timeout`, `shutting_down`, `start_error`, `start_timeout`, `starting` | +| `startup_script_behavior` | `blocking`, `non-blocking` | +| `status` | `connected`, `connecting`, `disconnected`, `timeout` | +| `workspace_transition` | `delete`, `start`, `stop` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -2953,15 +2902,10 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|----------------------| -| `log_level` | `trace` | -| `log_level` | `debug` | -| `log_level` | `info` | -| `log_level` | `warn` | -| `log_level` | `error` | -| `log_source` | `provisioner_daemon` | -| `log_source` | `provisioner` | +| Property | Value(s) | +|--------------|-------------------------------------------| +| `log_level` | `debug`, `error`, `info`, `trace`, `warn` | +| `log_source` | `provisioner`, `provisioner_daemon` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3337,40 +3281,16 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|---------------------------|--------------------| -| `health` | `disabled` | -| `health` | `initializing` | -| `health` | `healthy` | -| `health` | `unhealthy` | -| `open_in` | `slim-window` | -| `open_in` | `tab` | -| `sharing_level` | `owner` | -| `sharing_level` | `authenticated` | -| `sharing_level` | `organization` | -| `sharing_level` | `public` | -| `state` | `working` | -| `state` | `idle` | -| `state` | `complete` | -| `state` | `failure` | -| `lifecycle_state` | `created` | -| `lifecycle_state` | `starting` | -| `lifecycle_state` | `start_timeout` | -| `lifecycle_state` | `start_error` | -| `lifecycle_state` | `ready` | -| `lifecycle_state` | `shutting_down` | -| `lifecycle_state` | `shutdown_timeout` | -| `lifecycle_state` | `shutdown_error` | -| `lifecycle_state` | `off` | -| `startup_script_behavior` | `blocking` | -| `startup_script_behavior` | `non-blocking` | -| `status` | `connecting` | -| `status` | `connected` | -| `status` | `disconnected` | -| `status` | `timeout` | -| `workspace_transition` | `start` | -| `workspace_transition` | `stop` | -| `workspace_transition` | `delete` | +| Property | Value(s) | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------| +| `health` | `disabled`, `healthy`, `initializing`, `unhealthy` | +| `open_in` | `slim-window`, `tab` | +| `sharing_level` | `authenticated`, `organization`, `owner`, `public` | +| `state` | `complete`, `failure`, `idle`, `working` | +| `lifecycle_state` | `created`, `off`, `ready`, `shutdown_error`, `shutdown_timeout`, `shutting_down`, `start_error`, `start_timeout`, `starting` | +| `startup_script_behavior` | `blocking`, `non-blocking` | +| `status` | `connected`, `connecting`, `disconnected`, `timeout` | +| `workspace_transition` | `delete`, `start`, `stop` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3465,25 +3385,11 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|------------------------|----------------| -| `form_type` | `` | -| `form_type` | `radio` | -| `form_type` | `dropdown` | -| `form_type` | `input` | -| `form_type` | `textarea` | -| `form_type` | `slider` | -| `form_type` | `checkbox` | -| `form_type` | `switch` | -| `form_type` | `tag-select` | -| `form_type` | `multi-select` | -| `form_type` | `error` | -| `type` | `string` | -| `type` | `number` | -| `type` | `bool` | -| `type` | `list(string)` | -| `validation_monotonic` | `increasing` | -| `validation_monotonic` | `decreasing` | +| Property | Value(s) | +|------------------------|---------------------------------------------------------------------------------------------------------------------| +| `form_type` | ``, `checkbox`, `dropdown`, `error`, `input`, `multi-select`, `radio`, `slider`, `switch`, `tag-select`, `textarea` | +| `type` | `bool`, `list(string)`, `number`, `string` | +| `validation_monotonic` | `decreasing`, `increasing` | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -3617,10 +3523,8 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|----------|----------| -| `type` | `string` | -| `type` | `number` | -| `type` | `bool` | +| Property | Value(s) | +|----------|----------------------------| +| `type` | `bool`, `number`, `string` | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/users.md b/docs/reference/api/users.md index c69c57af85..b034437cce 100644 --- a/docs/reference/api/users.md +++ b/docs/reference/api/users.md @@ -810,56 +810,11 @@ Status Code **200** #### Enumerated Values -| Property | Value | -|--------------|------------------------------------| -| `type` | `*` | -| `type` | `aibridge_interception` | -| `type` | `api_key` | -| `type` | `assign_org_role` | -| `type` | `assign_role` | -| `type` | `audit_log` | -| `type` | `connection_log` | -| `type` | `crypto_key` | -| `type` | `debug_info` | -| `type` | `deployment_config` | -| `type` | `deployment_stats` | -| `type` | `file` | -| `type` | `group` | -| `type` | `group_member` | -| `type` | `idpsync_settings` | -| `type` | `inbox_notification` | -| `type` | `license` | -| `type` | `notification_message` | -| `type` | `notification_preference` | -| `type` | `notification_template` | -| `type` | `oauth2_app` | -| `type` | `oauth2_app_code_token` | -| `type` | `oauth2_app_secret` | -| `type` | `organization` | -| `type` | `organization_member` | -| `type` | `prebuilt_workspace` | -| `type` | `provisioner_daemon` | -| `type` | `provisioner_jobs` | -| `type` | `replicas` | -| `type` | `system` | -| `type` | `tailnet_coordinator` | -| `type` | `task` | -| `type` | `template` | -| `type` | `usage_event` | -| `type` | `user` | -| `type` | `user_secret` | -| `type` | `webpush_subscription` | -| `type` | `workspace` | -| `type` | `workspace_agent_devcontainers` | -| `type` | `workspace_agent_resource_monitor` | -| `type` | `workspace_dormant` | -| `type` | `workspace_proxy` | -| `login_type` | `password` | -| `login_type` | `github` | -| `login_type` | `oidc` | -| `login_type` | `token` | -| `scope` | `all` | -| `scope` | `application_connect` | +| Property | Value(s) | +|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `type` | `*`, `aibridge_interception`, `api_key`, `assign_org_role`, `assign_role`, `audit_log`, `connection_log`, `crypto_key`, `debug_info`, `deployment_config`, `deployment_stats`, `file`, `group`, `group_member`, `idpsync_settings`, `inbox_notification`, `license`, `notification_message`, `notification_preference`, `notification_template`, `oauth2_app`, `oauth2_app_code_token`, `oauth2_app_secret`, `organization`, `organization_member`, `prebuilt_workspace`, `provisioner_daemon`, `provisioner_jobs`, `replicas`, `system`, `tailnet_coordinator`, `task`, `template`, `usage_event`, `user`, `user_secret`, `webpush_subscription`, `workspace`, `workspace_agent_devcontainers`, `workspace_agent_resource_monitor`, `workspace_dormant`, `workspace_proxy` | +| `login_type` | `github`, `oidc`, `password`, `token` | +| `scope` | `all`, `application_connect` | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/scripts/apidocgen/markdown-template/main.dot b/scripts/apidocgen/markdown-template/main.dot index 86e0136fbe..84bcce5e8a 100644 --- a/scripts/apidocgen/markdown-template/main.dot +++ b/scripts/apidocgen/markdown-template/main.dot @@ -60,9 +60,33 @@ return correctLetterCase(description); } + /** + * Groups an array of {name, value} enum entries by name. + * Returns an array of {name, values: []} objects with sorted, unique values. + */ + function groupEnumsByName(enums) { + var grouped = {}; + for (var i = 0; i < enums.length; i++) { + var e = enums[i]; + if (!grouped[e.name]) { + grouped[e.name] = []; + } + if (grouped[e.name].indexOf(e.value) === -1) { + grouped[e.name].push(e.value); + } + } + var result = []; + for (var name in grouped) { + grouped[name].sort(); + result.push({name: name, values: grouped[name]}); + } + return result; + } + /* Export functions that are used by other template partials. */ data.functions = {}; data.functions.renderDescription = renderDescription; + data.functions.groupEnumsByName = groupEnumsByName; }} {{? data.api.components && data.api.components.securitySchemes }}{{#def.security}}{{?}} @@ -153,15 +177,16 @@ None #### Enumerated Values {{? block.rows.length > 0 && block.rows[0].displayName != "*anonymous*"}} -|Property|Value| +{{ var groupedEnums = groupEnumsByName(enums); }} +|Property|Value(s)| |---|---| -{{~ enums :e}}|`{{=e.name}}`|`{{=data.utils.toPrimitive(e.value)}}`| +{{~ groupedEnums :e}}|`{{=e.name}}`|{{~ e.values :v:idx}}`{{=data.utils.toPrimitive(v)}}`{{? idx < e.values.length - 1}}, {{?}}{{~}}| {{~}} {{??}} -|Value| +{{ var allValues = []; for (var i = 0; i < enums.length; i++) { if (allValues.indexOf(enums[i].value) === -1) allValues.push(enums[i].value); } allValues.sort(); }} +|Value(s)| |---| -{{~ enums :e}}|`{{=data.utils.toPrimitive(e.value)}}`| -{{~}} +|{{~ allValues :v:idx}}`{{=data.utils.toPrimitive(v)}}`{{? idx < allValues.length - 1}}, {{?}}{{~}}| {{?}} {{= data.tags.endSection }} diff --git a/scripts/apidocgen/markdown-template/parameters.def b/scripts/apidocgen/markdown-template/parameters.def index 8a1107a605..192094bf09 100644 --- a/scripts/apidocgen/markdown-template/parameters.def +++ b/scripts/apidocgen/markdown-template/parameters.def @@ -43,11 +43,12 @@ {{~}} {{? data.enums && data.enums.length }} +{{ var groupedEnums = data.functions.groupEnumsByName(data.enums); }} #### Enumerated Values -|Parameter|Value| +|Parameter|Value(s)| |---|---| -{{~ data.enums :e}}|`{{=e.name}}`|`{{=data.utils.toPrimitive(e.value)}}`| +{{~ groupedEnums :e}}|`{{=e.name}}`|{{~ e.values :v:idx}}`{{=data.utils.toPrimitive(v)}}`{{? idx < e.values.length - 1}}, {{?}}{{~}}| {{~}} {{?}} {{= data.tags.endSection }} diff --git a/scripts/apidocgen/markdown-template/responses.def b/scripts/apidocgen/markdown-template/responses.def index 02421e11c5..66a733b7bb 100644 --- a/scripts/apidocgen/markdown-template/responses.def +++ b/scripts/apidocgen/markdown-template/responses.def @@ -107,11 +107,12 @@ Status Code **{{=response.status}}** {{?}} {{? enums.length > 0 }} +{{ var groupedEnums = data.functions.groupEnumsByName(enums); }} #### Enumerated Values -|Property|Value| +|Property|Value(s)| |---|---| -{{~ enums :e}}|`{{=e.name}}`|`{{=data.utils.toPrimitive(e.value)}}`| +{{~ groupedEnums :e}}|`{{=e.name}}`|{{~ e.values :v:idx}}`{{=data.utils.toPrimitive(v)}}`{{? idx < e.values.length - 1}}, {{?}}{{~}}| {{~}} {{?}}