feat: add is_prebuild flag to workspace API response

coder · ssncferreira · Jul 15, 2025 · Jul 10, 2025 · Jul 10, 2025 · Jul 10, 2025
commit 207c80ff213447a4f7e23699573a71f6daaec9cd
diff --git a/cli/testdata/coder_list_--output_json.golden b/cli/testdata/coder_list_--output_json.golden
@@ -86,6 +86,7 @@
     "automatic_updates": "never",
     "allow_renames": false,
     "favorite": false,
-    "next_start_at": "====[timestamp]====="
+    "next_start_at": "====[timestamp]=====",
+    "is_prebuild": false
   }
 ]
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -2231,6 +2231,12 @@ func convertWorkspace(
 	if latestAppStatus.ID == uuid.Nil {
 		appStatus = nil
 	}
+
+	isPrebuild := false
+	if workspace.OwnerID == database.PrebuildsSystemUserID {
+		isPrebuild = true
+	}
+
 	return codersdk.Workspace{
 		ID:                                   workspace.ID,
 		CreatedAt:                            workspace.CreatedAt,
@@ -2265,6 +2271,7 @@ func convertWorkspace(
 		AllowRenames:     allowRenames,
 		Favorite:         requesterFavorite,
 		NextStartAt:      nextStartAt,
+		IsPrebuild:       isPrebuild,
 	}, nil
 }
 

diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -66,6 +66,7 @@ type Workspace struct {
 	AllowRenames     bool             `json:"allow_renames"`
 	Favorite         bool             `json:"favorite"`
 	NextStartAt      *time.Time       `json:"next_start_at" format:"date-time"`
+	IsPrebuild       bool             `json:"is_prebuild"`
 }
 
 func (w Workspace) FullName() string {

diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md
diff --git a/docs/reference/api/workspaces.md b/docs/reference/api/workspaces.md
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/modules/workspaces/prebuilds.ts b/site/src/modules/workspaces/prebuilds.ts
@@ -11,7 +11,6 @@ import { Link } from "components/Link/Link";
 import { Loader } from "components/Loader/Loader";
 import { PageHeader, PageHeaderTitle } from "components/PageHeader/PageHeader";
 import dayjs from "dayjs";
-import { isPrebuiltWorkspace } from "modules/workspaces/prebuilds";
 import {
 	scheduleChanged,
 	scheduleToAutostart,
@@ -98,13 +97,10 @@ const WorkspaceSchedulePage: FC = () => {
 			)}
 
 			{template &&
-				// Prebuilt workspaces have their own scheduling system,
-				// so we avoid showing the workspace-level schedule settings form.
-				// Instead, show an informational message with a link to the relevant docs.
-				(isPrebuiltWorkspace(workspace) ? (
+				(workspace.is_prebuild ? (
 					<Alert severity="info">
-						Prebuilt workspaces do not support workspace-level scheduling. For
-						prebuilt workspace specific scheduling refer to the{" "}
+						Prebuilt workspaces ignore workspace-level scheduling until they are claimed.
+						For prebuilt workspace specific scheduling refer to the{" "}
 						<Link
 							title="Prebuilt Workspaces Scheduling"
 							href={docs(

diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -1411,6 +1411,7 @@ export const MockWorkspace: TypesGen.Workspace = {
 	deleting_at: null,
 	dormant_at: null,
 	next_start_at: null,
+	is_prebuild: false,
 };
 
 export const MockFavoriteWorkspace: TypesGen.Workspace = {