chore: add comment to IsPrebuild parameter on codersdk.Workspaces

ssncferreira · ssncferreira · commit 0bde2549aa8c · 2025-07-14T16:18:28.000Z
diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -66,7 +66,12 @@ 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"`
+	// IsPrebuild indicates whether the workspace is a prebuilt workspace.
+	// Prebuilt workspaces are owned by the prebuilds system user and have specific behavior,
+	// such as being managed differently from regular workspaces.
+	// Once a prebuilt workspace is claimed by a user, it transitions to a regular workspace,
+	// and IsPrebuild returns false.
+	IsPrebuild bool `json:"is_prebuild"`
 }
 
 func (w Workspace) FullName() string {
