diff --git a/cli/testdata/coder_provisioner_jobs_list_--help.golden b/cli/testdata/coder_provisioner_jobs_list_--help.golden
index 3a581bd880..ccf4cea2dd 100644
--- a/cli/testdata/coder_provisioner_jobs_list_--help.golden
+++ b/cli/testdata/coder_provisioner_jobs_list_--help.golden
@@ -11,7 +11,7 @@ OPTIONS:
-O, --org string, $CODER_ORGANIZATION
Select which organization (uuid or name) to use.
- -c, --column [id|created at|started at|completed at|canceled at|error|error code|status|worker id|worker name|file id|tags|queue position|queue size|organization id|initiator id|template version id|workspace build id|type|available workers|template version name|template id|template name|template display name|template icon|workspace id|workspace name|logs overflowed|organization|queue] (default: created at,id,type,template display name,status,queue,tags)
+ -c, --column [id|created at|started at|completed at|canceled at|error|error code|status|worker id|worker name|file id|tags|queue position|queue size|organization id|initiator id|template version id|workspace build id|type|available workers|template version name|template id|template name|template display name|template icon|workspace id|workspace name|workspace build transition|logs overflowed|organization|queue] (default: created at,id,type,template display name,status,queue,tags)
Columns to display in table output.
-i, --initiator string, $CODER_PROVISIONER_JOB_LIST_INITIATOR
diff --git a/cli/testdata/coder_provisioner_jobs_list_--output_json.golden b/cli/testdata/coder_provisioner_jobs_list_--output_json.golden
index 3ee6c25e34..253d97e49a 100644
--- a/cli/testdata/coder_provisioner_jobs_list_--output_json.golden
+++ b/cli/testdata/coder_provisioner_jobs_list_--output_json.golden
@@ -58,7 +58,8 @@
"template_display_name": "",
"template_icon": "",
"workspace_id": "===========[workspace ID]===========",
- "workspace_name": "test-workspace"
+ "workspace_name": "test-workspace",
+ "workspace_build_transition": "start"
},
"logs_overflowed": false,
"organization_name": "Coder"
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
index ca60c0b1f6..af8657d52a 100644
--- a/coderd/apidoc/docs.go
+++ b/coderd/apidoc/docs.go
@@ -19149,6 +19149,9 @@ const docTemplate = `{
"template_version_name": {
"type": "string"
},
+ "workspace_build_transition": {
+ "$ref": "#/definitions/codersdk.WorkspaceTransition"
+ },
"workspace_id": {
"type": "string",
"format": "uuid"
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
index 22565df4bf..fbc07fa8e6 100644
--- a/coderd/apidoc/swagger.json
+++ b/coderd/apidoc/swagger.json
@@ -17509,6 +17509,9 @@
"template_version_name": {
"type": "string"
},
+ "workspace_build_transition": {
+ "$ref": "#/definitions/codersdk.WorkspaceTransition"
+ },
"workspace_id": {
"type": "string",
"format": "uuid"
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
index 14a3bbbc12..7f82407e00 100644
--- a/coderd/database/queries.sql.go
+++ b/coderd/database/queries.sql.go
@@ -17514,7 +17514,8 @@ SELECT
w.id AS workspace_id,
COALESCE(w.name, '') AS workspace_name,
-- Include the name of the provisioner_daemon associated to the job
- COALESCE(pd.name, '') AS worker_name
+ COALESCE(pd.name, '') AS worker_name,
+ wb.transition as workspace_build_transition
FROM
provisioner_jobs pj
LEFT JOIN
@@ -17559,7 +17560,8 @@ GROUP BY
t.icon,
w.id,
w.name,
- pd.name
+ pd.name,
+ wb.transition
ORDER BY
pj.created_at DESC
LIMIT
@@ -17576,18 +17578,19 @@ type GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisionerPar
}
type GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisionerRow struct {
- ProvisionerJob ProvisionerJob `db:"provisioner_job" json:"provisioner_job"`
- QueuePosition int64 `db:"queue_position" json:"queue_position"`
- QueueSize int64 `db:"queue_size" json:"queue_size"`
- AvailableWorkers []uuid.UUID `db:"available_workers" json:"available_workers"`
- TemplateVersionName string `db:"template_version_name" json:"template_version_name"`
- TemplateID uuid.NullUUID `db:"template_id" json:"template_id"`
- TemplateName string `db:"template_name" json:"template_name"`
- TemplateDisplayName string `db:"template_display_name" json:"template_display_name"`
- TemplateIcon string `db:"template_icon" json:"template_icon"`
- WorkspaceID uuid.NullUUID `db:"workspace_id" json:"workspace_id"`
- WorkspaceName string `db:"workspace_name" json:"workspace_name"`
- WorkerName string `db:"worker_name" json:"worker_name"`
+ ProvisionerJob ProvisionerJob `db:"provisioner_job" json:"provisioner_job"`
+ QueuePosition int64 `db:"queue_position" json:"queue_position"`
+ QueueSize int64 `db:"queue_size" json:"queue_size"`
+ AvailableWorkers []uuid.UUID `db:"available_workers" json:"available_workers"`
+ TemplateVersionName string `db:"template_version_name" json:"template_version_name"`
+ TemplateID uuid.NullUUID `db:"template_id" json:"template_id"`
+ TemplateName string `db:"template_name" json:"template_name"`
+ TemplateDisplayName string `db:"template_display_name" json:"template_display_name"`
+ TemplateIcon string `db:"template_icon" json:"template_icon"`
+ WorkspaceID uuid.NullUUID `db:"workspace_id" json:"workspace_id"`
+ WorkspaceName string `db:"workspace_name" json:"workspace_name"`
+ WorkerName string `db:"worker_name" json:"worker_name"`
+ WorkspaceBuildTransition NullWorkspaceTransition `db:"workspace_build_transition" json:"workspace_build_transition"`
}
func (q *sqlQuerier) GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisioner(ctx context.Context, arg GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisionerParams) ([]GetProvisionerJobsByOrganizationAndStatusWithQueuePositionAndProvisionerRow, error) {
@@ -17639,6 +17642,7 @@ func (q *sqlQuerier) GetProvisionerJobsByOrganizationAndStatusWithQueuePositionA
&i.WorkspaceID,
&i.WorkspaceName,
&i.WorkerName,
+ &i.WorkspaceBuildTransition,
); err != nil {
return nil, err
}
diff --git a/coderd/database/queries/provisionerjobs.sql b/coderd/database/queries/provisionerjobs.sql
index f57f907631..1b30e1edee 100644
--- a/coderd/database/queries/provisionerjobs.sql
+++ b/coderd/database/queries/provisionerjobs.sql
@@ -195,7 +195,8 @@ SELECT
w.id AS workspace_id,
COALESCE(w.name, '') AS workspace_name,
-- Include the name of the provisioner_daemon associated to the job
- COALESCE(pd.name, '') AS worker_name
+ COALESCE(pd.name, '') AS worker_name,
+ wb.transition as workspace_build_transition
FROM
provisioner_jobs pj
LEFT JOIN
@@ -240,7 +241,8 @@ GROUP BY
t.icon,
w.id,
w.name,
- pd.name
+ pd.name,
+ wb.transition
ORDER BY
pj.created_at DESC
LIMIT
diff --git a/coderd/provisionerjobs.go b/coderd/provisionerjobs.go
index 15886dbf50..bf5a644795 100644
--- a/coderd/provisionerjobs.go
+++ b/coderd/provisionerjobs.go
@@ -435,6 +435,9 @@ func convertProvisionerJobWithQueuePosition(pj database.GetProvisionerJobsByOrga
if pj.WorkspaceID.Valid {
job.Metadata.WorkspaceID = &pj.WorkspaceID.UUID
}
+ if pj.WorkspaceBuildTransition.Valid {
+ job.Metadata.WorkspaceBuildTransition = codersdk.WorkspaceTransition(pj.WorkspaceBuildTransition.WorkspaceTransition)
+ }
return job
}
diff --git a/coderd/provisionerjobs_test.go b/coderd/provisionerjobs_test.go
index 6584b6e241..ca7fe7cbca 100644
--- a/coderd/provisionerjobs_test.go
+++ b/coderd/provisionerjobs_test.go
@@ -97,13 +97,14 @@ func TestProvisionerJobs(t *testing.T) {
// Verify that job metadata is correct.
assert.Equal(t, job2.Metadata, codersdk.ProvisionerJobMetadata{
- TemplateVersionName: version.Name,
- TemplateID: template.ID,
- TemplateName: template.Name,
- TemplateDisplayName: template.DisplayName,
- TemplateIcon: template.Icon,
- WorkspaceID: &w.ID,
- WorkspaceName: w.Name,
+ TemplateVersionName: version.Name,
+ TemplateID: template.ID,
+ TemplateName: template.Name,
+ TemplateDisplayName: template.DisplayName,
+ TemplateIcon: template.Icon,
+ WorkspaceID: &w.ID,
+ WorkspaceName: w.Name,
+ WorkspaceBuildTransition: codersdk.WorkspaceTransitionStart,
})
})
})
diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go
index dde6ec7dea..cbc603d984 100644
--- a/codersdk/provisionerdaemons.go
+++ b/codersdk/provisionerdaemons.go
@@ -143,13 +143,14 @@ type ProvisionerJobInput struct {
// ProvisionerJobMetadata contains metadata for the job.
type ProvisionerJobMetadata struct {
- TemplateVersionName string `json:"template_version_name" table:"template version name"`
- TemplateID uuid.UUID `json:"template_id" format:"uuid" table:"template id"`
- TemplateName string `json:"template_name" table:"template name"`
- TemplateDisplayName string `json:"template_display_name" table:"template display name"`
- TemplateIcon string `json:"template_icon" table:"template icon"`
- WorkspaceID *uuid.UUID `json:"workspace_id,omitempty" format:"uuid" table:"workspace id"`
- WorkspaceName string `json:"workspace_name,omitempty" table:"workspace name"`
+ TemplateVersionName string `json:"template_version_name" table:"template version name"`
+ TemplateID uuid.UUID `json:"template_id" format:"uuid" table:"template id"`
+ TemplateName string `json:"template_name" table:"template name"`
+ TemplateDisplayName string `json:"template_display_name" table:"template display name"`
+ TemplateIcon string `json:"template_icon" table:"template icon"`
+ WorkspaceID *uuid.UUID `json:"workspace_id,omitempty" format:"uuid" table:"workspace id"`
+ WorkspaceName string `json:"workspace_name,omitempty" table:"workspace name"`
+ WorkspaceBuildTransition WorkspaceTransition `json:"workspace_build_transition,omitempty" table:"workspace build transition"`
}
// ProvisionerJobType represents the type of job.
diff --git a/docs/reference/api/builds.md b/docs/reference/api/builds.md
index c52366d8be..6bc15054ec 100644
--- a/docs/reference/api/builds.md
+++ b/docs/reference/api/builds.md
@@ -60,6 +60,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -300,6 +301,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1008,6 +1010,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1359,6 +1362,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1577,6 +1581,7 @@ Status Code **200**
| `»»» template_id` | string(uuid) | false | | |
| `»»» template_name` | string | false | | |
| `»»» template_version_name` | string | false | | |
+| `»»» workspace_build_transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | |
| `»»» workspace_id` | string(uuid) | false | | |
| `»»» workspace_name` | string | false | | |
| `»» organization_id` | string(uuid) | false | | |
@@ -1710,20 +1715,21 @@ Status Code **200**
#### Enumerated Values
-| 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` |
+| Property | Value(s) |
+|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
+| `workspace_build_transition` | `delete`, `start`, `stop` |
+| `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).
@@ -1810,6 +1816,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
diff --git a/docs/reference/api/organizations.md b/docs/reference/api/organizations.md
index 2c37feefff..f8f368f900 100644
--- a/docs/reference/api/organizations.md
+++ b/docs/reference/api/organizations.md
@@ -317,6 +317,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -346,49 +347,51 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi
Status Code **200**
-| Name | Type | Required | Restrictions | Description |
-|----------------------------|------------------------------------------------------------------------------|----------|--------------|-------------|
-| `[array item]` | array | false | | |
-| `» available_workers` | array | false | | |
-| `» canceled_at` | string(date-time) | false | | |
-| `» completed_at` | string(date-time) | false | | |
-| `» created_at` | string(date-time) | false | | |
-| `» error` | string | false | | |
-| `» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | |
-| `» file_id` | string(uuid) | false | | |
-| `» id` | string(uuid) | false | | |
-| `» initiator_id` | string(uuid) | false | | |
-| `» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | |
-| `»» error` | string | false | | |
-| `»» template_version_id` | string(uuid) | false | | |
-| `»» workspace_build_id` | string(uuid) | false | | |
-| `» logs_overflowed` | boolean | false | | |
-| `» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | |
-| `»» template_display_name` | string | false | | |
-| `»» template_icon` | string | false | | |
-| `»» template_id` | string(uuid) | false | | |
-| `»» template_name` | string | false | | |
-| `»» template_version_name` | string | false | | |
-| `»» workspace_id` | string(uuid) | false | | |
-| `»» workspace_name` | string | false | | |
-| `» organization_id` | string(uuid) | false | | |
-| `» queue_position` | integer | false | | |
-| `» queue_size` | integer | false | | |
-| `» started_at` | string(date-time) | false | | |
-| `» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | |
-| `» tags` | object | false | | |
-| `»» [any property]` | string | false | | |
-| `» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | |
-| `» worker_id` | string(uuid) | false | | |
-| `» worker_name` | string | false | | |
+| Name | Type | Required | Restrictions | Description |
+|---------------------------------|------------------------------------------------------------------------------|----------|--------------|-------------|
+| `[array item]` | array | false | | |
+| `» available_workers` | array | false | | |
+| `» canceled_at` | string(date-time) | false | | |
+| `» completed_at` | string(date-time) | false | | |
+| `» created_at` | string(date-time) | false | | |
+| `» error` | string | false | | |
+| `» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | |
+| `» file_id` | string(uuid) | false | | |
+| `» id` | string(uuid) | false | | |
+| `» initiator_id` | string(uuid) | false | | |
+| `» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | |
+| `»» error` | string | false | | |
+| `»» template_version_id` | string(uuid) | false | | |
+| `»» workspace_build_id` | string(uuid) | false | | |
+| `» logs_overflowed` | boolean | false | | |
+| `» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | |
+| `»» template_display_name` | string | false | | |
+| `»» template_icon` | string | false | | |
+| `»» template_id` | string(uuid) | false | | |
+| `»» template_name` | string | false | | |
+| `»» template_version_name` | string | false | | |
+| `»» workspace_build_transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | |
+| `»» workspace_id` | string(uuid) | false | | |
+| `»» workspace_name` | string | false | | |
+| `» organization_id` | string(uuid) | false | | |
+| `» queue_position` | integer | false | | |
+| `» queue_size` | integer | false | | |
+| `» started_at` | string(date-time) | false | | |
+| `» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | |
+| `» tags` | object | false | | |
+| `»» [any property]` | string | false | | |
+| `» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | |
+| `» worker_id` | string(uuid) | false | | |
+| `» worker_name` | string | false | | |
#### Enumerated Values
-| 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` |
+| Property | Value(s) |
+|------------------------------|--------------------------------------------------------------------------|
+| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
+| `workspace_build_transition` | `delete`, `start`, `stop` |
+| `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).
@@ -441,6 +444,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md
index 259ed26c7d..302b9bbd37 100644
--- a/docs/reference/api/schemas.md
+++ b/docs/reference/api/schemas.md
@@ -7121,6 +7121,7 @@ Only certain features set these fields: - FeatureManagedAgentLimit|
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -7787,6 +7788,7 @@ Only certain features set these fields: - FeatureManagedAgentLimit|
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -7896,6 +7898,7 @@ Only certain features set these fields: - FeatureManagedAgentLimit|
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
}
@@ -7903,15 +7906,16 @@ Only certain features set these fields: - FeatureManagedAgentLimit|
### Properties
-| Name | Type | Required | Restrictions | Description |
-|-------------------------|--------|----------|--------------|-------------|
-| `template_display_name` | string | false | | |
-| `template_icon` | string | false | | |
-| `template_id` | string | false | | |
-| `template_name` | string | false | | |
-| `template_version_name` | string | false | | |
-| `workspace_id` | string | false | | |
-| `workspace_name` | string | false | | |
+| Name | Type | Required | Restrictions | Description |
+|------------------------------|--------------------------------------------------------------|----------|--------------|-------------|
+| `template_display_name` | string | false | | |
+| `template_icon` | string | false | | |
+| `template_id` | string | false | | |
+| `template_name` | string | false | | |
+| `template_version_name` | string | false | | |
+| `workspace_build_transition` | [codersdk.WorkspaceTransition](#codersdkworkspacetransition) | false | | |
+| `workspace_id` | string | false | | |
+| `workspace_name` | string | false | | |
## codersdk.ProvisionerJobStatus
@@ -8467,6 +8471,7 @@ Only certain features set these fields: - FeatureManagedAgentLimit|
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -10014,6 +10019,7 @@ Restarts will only happen on weekdays in this list on weeks which line up with W
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -11404,6 +11410,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -12562,6 +12569,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -13394,6 +13402,7 @@ If the schedule is empty, the user will be updated to use the default schedule.|
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
diff --git a/docs/reference/api/tasks.md b/docs/reference/api/tasks.md
index dae7a74975..f1f0e1fe7a 100644
--- a/docs/reference/api/tasks.md
+++ b/docs/reference/api/tasks.md
@@ -425,6 +425,7 @@ curl -X POST http://coder-server:8080/api/v2/tasks/{user}/{task}/pause \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -668,6 +669,7 @@ curl -X POST http://coder-server:8080/api/v2/tasks/{user}/{task}/resume \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
diff --git a/docs/reference/api/templates.md b/docs/reference/api/templates.md
index 3a8c871cc7..f23a670fdf 100644
--- a/docs/reference/api/templates.md
+++ b/docs/reference/api/templates.md
@@ -493,6 +493,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -595,6 +596,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -721,6 +723,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1335,6 +1338,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1379,70 +1383,72 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
Status Code **200**
-| Name | Type | Required | Restrictions | Description |
-|-----------------------------|------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `[array item]` | array | false | | |
-| `» archived` | boolean | false | | |
-| `» created_at` | string(date-time) | false | | |
-| `» created_by` | [codersdk.MinimalUser](schemas.md#codersdkminimaluser) | false | | |
-| `»» avatar_url` | string(uri) | false | | |
-| `»» id` | string(uuid) | true | | |
-| `»» name` | string | false | | |
-| `»» username` | string | true | | |
-| `» has_external_agent` | boolean | false | | |
-| `» id` | string(uuid) | false | | |
-| `» job` | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | false | | |
-| `»» available_workers` | array | false | | |
-| `»» canceled_at` | string(date-time) | false | | |
-| `»» completed_at` | string(date-time) | false | | |
-| `»» created_at` | string(date-time) | false | | |
-| `»» error` | string | false | | |
-| `»» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | |
-| `»» file_id` | string(uuid) | false | | |
-| `»» id` | string(uuid) | false | | |
-| `»» initiator_id` | string(uuid) | false | | |
-| `»» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | |
-| `»»» error` | string | false | | |
-| `»»» template_version_id` | string(uuid) | false | | |
-| `»»» workspace_build_id` | string(uuid) | false | | |
-| `»» logs_overflowed` | boolean | false | | |
-| `»» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | |
-| `»»» template_display_name` | string | false | | |
-| `»»» template_icon` | string | false | | |
-| `»»» template_id` | string(uuid) | false | | |
-| `»»» template_name` | string | false | | |
-| `»»» template_version_name` | string | false | | |
-| `»»» workspace_id` | string(uuid) | false | | |
-| `»»» workspace_name` | string | false | | |
-| `»» organization_id` | string(uuid) | false | | |
-| `»» queue_position` | integer | false | | |
-| `»» queue_size` | integer | false | | |
-| `»» started_at` | string(date-time) | false | | |
-| `»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | |
-| `»» tags` | object | false | | |
-| `»»» [any property]` | string | false | | |
-| `»» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | |
-| `»» worker_id` | string(uuid) | false | | |
-| `»» worker_name` | string | false | | |
-| `» matched_provisioners` | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | false | | |
-| `»» available` | integer | false | | Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped. |
-| `»» count` | integer | false | | Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags. |
-| `»» most_recently_seen` | string(date-time) | false | | Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null. |
-| `» message` | string | false | | |
-| `» name` | string | false | | |
-| `» organization_id` | string(uuid) | false | | |
-| `» readme` | string | false | | |
-| `» template_id` | string(uuid) | false | | |
-| `» updated_at` | string(date-time) | false | | |
-| `» warnings` | array | false | | |
+| Name | Type | Required | Restrictions | Description |
+|----------------------------------|------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `[array item]` | array | false | | |
+| `» archived` | boolean | false | | |
+| `» created_at` | string(date-time) | false | | |
+| `» created_by` | [codersdk.MinimalUser](schemas.md#codersdkminimaluser) | false | | |
+| `»» avatar_url` | string(uri) | false | | |
+| `»» id` | string(uuid) | true | | |
+| `»» name` | string | false | | |
+| `»» username` | string | true | | |
+| `» has_external_agent` | boolean | false | | |
+| `» id` | string(uuid) | false | | |
+| `» job` | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | false | | |
+| `»» available_workers` | array | false | | |
+| `»» canceled_at` | string(date-time) | false | | |
+| `»» completed_at` | string(date-time) | false | | |
+| `»» created_at` | string(date-time) | false | | |
+| `»» error` | string | false | | |
+| `»» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | |
+| `»» file_id` | string(uuid) | false | | |
+| `»» id` | string(uuid) | false | | |
+| `»» initiator_id` | string(uuid) | false | | |
+| `»» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | |
+| `»»» error` | string | false | | |
+| `»»» template_version_id` | string(uuid) | false | | |
+| `»»» workspace_build_id` | string(uuid) | false | | |
+| `»» logs_overflowed` | boolean | false | | |
+| `»» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | |
+| `»»» template_display_name` | string | false | | |
+| `»»» template_icon` | string | false | | |
+| `»»» template_id` | string(uuid) | false | | |
+| `»»» template_name` | string | false | | |
+| `»»» template_version_name` | string | false | | |
+| `»»» workspace_build_transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | |
+| `»»» workspace_id` | string(uuid) | false | | |
+| `»»» workspace_name` | string | false | | |
+| `»» organization_id` | string(uuid) | false | | |
+| `»» queue_position` | integer | false | | |
+| `»» queue_size` | integer | false | | |
+| `»» started_at` | string(date-time) | false | | |
+| `»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | |
+| `»» tags` | object | false | | |
+| `»»» [any property]` | string | false | | |
+| `»» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | |
+| `»» worker_id` | string(uuid) | false | | |
+| `»» worker_name` | string | false | | |
+| `» matched_provisioners` | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | false | | |
+| `»» available` | integer | false | | Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped. |
+| `»» count` | integer | false | | Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags. |
+| `»» most_recently_seen` | string(date-time) | false | | Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null. |
+| `» message` | string | false | | |
+| `» name` | string | false | | |
+| `» organization_id` | string(uuid) | false | | |
+| `» readme` | string | false | | |
+| `» template_id` | string(uuid) | false | | |
+| `» updated_at` | string(date-time) | false | | |
+| `» warnings` | array | false | | |
#### Enumerated Values
-| 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` |
+| Property | Value(s) |
+|------------------------------|--------------------------------------------------------------------------|
+| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
+| `workspace_build_transition` | `delete`, `start`, `stop` |
+| `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).
@@ -1615,6 +1621,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1659,70 +1666,72 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ
Status Code **200**
-| Name | Type | Required | Restrictions | Description |
-|-----------------------------|------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `[array item]` | array | false | | |
-| `» archived` | boolean | false | | |
-| `» created_at` | string(date-time) | false | | |
-| `» created_by` | [codersdk.MinimalUser](schemas.md#codersdkminimaluser) | false | | |
-| `»» avatar_url` | string(uri) | false | | |
-| `»» id` | string(uuid) | true | | |
-| `»» name` | string | false | | |
-| `»» username` | string | true | | |
-| `» has_external_agent` | boolean | false | | |
-| `» id` | string(uuid) | false | | |
-| `» job` | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | false | | |
-| `»» available_workers` | array | false | | |
-| `»» canceled_at` | string(date-time) | false | | |
-| `»» completed_at` | string(date-time) | false | | |
-| `»» created_at` | string(date-time) | false | | |
-| `»» error` | string | false | | |
-| `»» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | |
-| `»» file_id` | string(uuid) | false | | |
-| `»» id` | string(uuid) | false | | |
-| `»» initiator_id` | string(uuid) | false | | |
-| `»» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | |
-| `»»» error` | string | false | | |
-| `»»» template_version_id` | string(uuid) | false | | |
-| `»»» workspace_build_id` | string(uuid) | false | | |
-| `»» logs_overflowed` | boolean | false | | |
-| `»» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | |
-| `»»» template_display_name` | string | false | | |
-| `»»» template_icon` | string | false | | |
-| `»»» template_id` | string(uuid) | false | | |
-| `»»» template_name` | string | false | | |
-| `»»» template_version_name` | string | false | | |
-| `»»» workspace_id` | string(uuid) | false | | |
-| `»»» workspace_name` | string | false | | |
-| `»» organization_id` | string(uuid) | false | | |
-| `»» queue_position` | integer | false | | |
-| `»» queue_size` | integer | false | | |
-| `»» started_at` | string(date-time) | false | | |
-| `»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | |
-| `»» tags` | object | false | | |
-| `»»» [any property]` | string | false | | |
-| `»» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | |
-| `»» worker_id` | string(uuid) | false | | |
-| `»» worker_name` | string | false | | |
-| `» matched_provisioners` | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | false | | |
-| `»» available` | integer | false | | Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped. |
-| `»» count` | integer | false | | Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags. |
-| `»» most_recently_seen` | string(date-time) | false | | Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null. |
-| `» message` | string | false | | |
-| `» name` | string | false | | |
-| `» organization_id` | string(uuid) | false | | |
-| `» readme` | string | false | | |
-| `» template_id` | string(uuid) | false | | |
-| `» updated_at` | string(date-time) | false | | |
-| `» warnings` | array | false | | |
+| Name | Type | Required | Restrictions | Description |
+|----------------------------------|------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `[array item]` | array | false | | |
+| `» archived` | boolean | false | | |
+| `» created_at` | string(date-time) | false | | |
+| `» created_by` | [codersdk.MinimalUser](schemas.md#codersdkminimaluser) | false | | |
+| `»» avatar_url` | string(uri) | false | | |
+| `»» id` | string(uuid) | true | | |
+| `»» name` | string | false | | |
+| `»» username` | string | true | | |
+| `» has_external_agent` | boolean | false | | |
+| `» id` | string(uuid) | false | | |
+| `» job` | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | false | | |
+| `»» available_workers` | array | false | | |
+| `»» canceled_at` | string(date-time) | false | | |
+| `»» completed_at` | string(date-time) | false | | |
+| `»» created_at` | string(date-time) | false | | |
+| `»» error` | string | false | | |
+| `»» error_code` | [codersdk.JobErrorCode](schemas.md#codersdkjoberrorcode) | false | | |
+| `»» file_id` | string(uuid) | false | | |
+| `»» id` | string(uuid) | false | | |
+| `»» initiator_id` | string(uuid) | false | | |
+| `»» input` | [codersdk.ProvisionerJobInput](schemas.md#codersdkprovisionerjobinput) | false | | |
+| `»»» error` | string | false | | |
+| `»»» template_version_id` | string(uuid) | false | | |
+| `»»» workspace_build_id` | string(uuid) | false | | |
+| `»» logs_overflowed` | boolean | false | | |
+| `»» metadata` | [codersdk.ProvisionerJobMetadata](schemas.md#codersdkprovisionerjobmetadata) | false | | |
+| `»»» template_display_name` | string | false | | |
+| `»»» template_icon` | string | false | | |
+| `»»» template_id` | string(uuid) | false | | |
+| `»»» template_name` | string | false | | |
+| `»»» template_version_name` | string | false | | |
+| `»»» workspace_build_transition` | [codersdk.WorkspaceTransition](schemas.md#codersdkworkspacetransition) | false | | |
+| `»»» workspace_id` | string(uuid) | false | | |
+| `»»» workspace_name` | string | false | | |
+| `»» organization_id` | string(uuid) | false | | |
+| `»» queue_position` | integer | false | | |
+| `»» queue_size` | integer | false | | |
+| `»» started_at` | string(date-time) | false | | |
+| `»» status` | [codersdk.ProvisionerJobStatus](schemas.md#codersdkprovisionerjobstatus) | false | | |
+| `»» tags` | object | false | | |
+| `»»» [any property]` | string | false | | |
+| `»» type` | [codersdk.ProvisionerJobType](schemas.md#codersdkprovisionerjobtype) | false | | |
+| `»» worker_id` | string(uuid) | false | | |
+| `»» worker_name` | string | false | | |
+| `» matched_provisioners` | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | false | | |
+| `»» available` | integer | false | | Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped. |
+| `»» count` | integer | false | | Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags. |
+| `»» most_recently_seen` | string(date-time) | false | | Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null. |
+| `» message` | string | false | | |
+| `» name` | string | false | | |
+| `» organization_id` | string(uuid) | false | | |
+| `» readme` | string | false | | |
+| `» template_id` | string(uuid) | false | | |
+| `» updated_at` | string(date-time) | false | | |
+| `» warnings` | array | false | | |
#### Enumerated Values
-| 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` |
+| Property | Value(s) |
+|------------------------------|--------------------------------------------------------------------------|
+| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
+| `workspace_build_transition` | `delete`, `start`, `stop` |
+| `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).
@@ -1785,6 +1794,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1896,6 +1906,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -2095,6 +2106,7 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -2170,6 +2182,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
diff --git a/docs/reference/api/workspaces.md b/docs/reference/api/workspaces.md
index 6e232f6ac7..e975fc2136 100644
--- a/docs/reference/api/workspaces.md
+++ b/docs/reference/api/workspaces.md
@@ -115,6 +115,7 @@ of the template will be used.
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -478,6 +479,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -808,6 +810,7 @@ of the template will be used.
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1116,6 +1119,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1405,6 +1409,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
@@ -1971,6 +1976,7 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
"template_version_name": "string",
+ "workspace_build_transition": "start",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string"
},
diff --git a/docs/reference/cli/provisioner_jobs_list.md b/docs/reference/cli/provisioner_jobs_list.md
index 0167dd467d..e845736890 100644
--- a/docs/reference/cli/provisioner_jobs_list.md
+++ b/docs/reference/cli/provisioner_jobs_list.md
@@ -54,10 +54,10 @@ Select which organization (uuid or name) to use.
### -c, --column
-| | |
-|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Type | [id\|created at\|started at\|completed at\|canceled at\|error\|error code\|status\|worker id\|worker name\|file id\|tags\|queue position\|queue size\|organization id\|initiator id\|template version id\|workspace build id\|type\|available workers\|template version name\|template id\|template name\|template display name\|template icon\|workspace id\|workspace name\|logs overflowed\|organization\|queue] |
-| Default | created at,id,type,template display name,status,queue,tags |
+| | |
+|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Type | [id\|created at\|started at\|completed at\|canceled at\|error\|error code\|status\|worker id\|worker name\|file id\|tags\|queue position\|queue size\|organization id\|initiator id\|template version id\|workspace build id\|type\|available workers\|template version name\|template id\|template name\|template display name\|template icon\|workspace id\|workspace name\|workspace build transition\|logs overflowed\|organization\|queue] |
+| Default | created at,id,type,template display name,status,queue,tags |
Columns to display in table output.
diff --git a/enterprise/cli/testdata/coder_provisioner_jobs_list_--help.golden b/enterprise/cli/testdata/coder_provisioner_jobs_list_--help.golden
index 3a581bd880..ccf4cea2dd 100644
--- a/enterprise/cli/testdata/coder_provisioner_jobs_list_--help.golden
+++ b/enterprise/cli/testdata/coder_provisioner_jobs_list_--help.golden
@@ -11,7 +11,7 @@ OPTIONS:
-O, --org string, $CODER_ORGANIZATION
Select which organization (uuid or name) to use.
- -c, --column [id|created at|started at|completed at|canceled at|error|error code|status|worker id|worker name|file id|tags|queue position|queue size|organization id|initiator id|template version id|workspace build id|type|available workers|template version name|template id|template name|template display name|template icon|workspace id|workspace name|logs overflowed|organization|queue] (default: created at,id,type,template display name,status,queue,tags)
+ -c, --column [id|created at|started at|completed at|canceled at|error|error code|status|worker id|worker name|file id|tags|queue position|queue size|organization id|initiator id|template version id|workspace build id|type|available workers|template version name|template id|template name|template display name|template icon|workspace id|workspace name|workspace build transition|logs overflowed|organization|queue] (default: created at,id,type,template display name,status,queue,tags)
Columns to display in table output.
-i, --initiator string, $CODER_PROVISIONER_JOB_LIST_INITIATOR
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
index 7b43193069..1b8db2f6e1 100644
--- a/site/src/api/typesGenerated.ts
+++ b/site/src/api/typesGenerated.ts
@@ -5615,6 +5615,7 @@ export interface ProvisionerJobMetadata {
readonly template_icon: string;
readonly workspace_id?: string;
readonly workspace_name?: string;
+ readonly workspace_build_transition?: WorkspaceTransition;
}
// From codersdk/provisionerdaemons.go