Method workspaceBuildUpdateState

coderd/workspacebuilds.go:903–949

@Summary Update workspace build state @ID update-workspace-build-state @Security CoderSessionToken @Accept json @Tags Builds @Param workspacebuild path string true "Workspace build ID" format(uuid) @Param request body codersdk.UpdateWorkspaceBuildStateRequest true "Request body" @Success 204 @Router

(rw http.ResponseWriter, r *http.Request)

// @Success 204
// @Router /api/v2/workspacebuilds/{workspacebuild}/state [put]
func (api *API) workspaceBuildUpdateState(rw http.ResponseWriter, r *http.Request) {
	ctx := r.Context()
	workspaceBuild := httpmw.WorkspaceBuildParam(r)
	workspace, err := api.Database.GetWorkspaceByID(ctx, workspaceBuild.WorkspaceID)
	if err != nil {
		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
			Message: "No workspace exists for this job.",
		})
		return
	}
	template, err := api.Database.GetTemplateByID(ctx, workspace.TemplateID)
	if err != nil {
		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
			Message: "Failed to get template",
			Detail:  err.Error(),
		})
		return
	}

	// You must have update permissions on the template to update the state.
	if !api.Authorize(r, policy.ActionUpdate, template.RBACObject()) {
		httpapi.ResourceNotFound(rw)
		return
	}

	var req codersdk.UpdateWorkspaceBuildStateRequest
	if !httpapi.Read(ctx, rw, r, &req) {
		return
	}

	// Use system context since we've already verified authorization via template permissions.
	// nolint:gocritic // System access required for provisioner state update.
	err = api.Database.UpdateWorkspaceBuildProvisionerStateByID(dbauthz.AsSystemRestricted(ctx), database.UpdateWorkspaceBuildProvisionerStateByIDParams{
		ID:               workspaceBuild.ID,
		ProvisionerState: req.State,
		UpdatedAt:        dbtime.Now(),
	})
	if err != nil {
		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
			Message: "Failed to update workspace build state.",
			Detail:  err.Error(),
		})
		return
	}

	rw.WriteHeader(http.StatusNoContent)
}

// @Summary Get workspace build timings by ID
// @ID get-workspace-build-timings-by-id