Skip to content

Commit e371069

Browse files
committed
mark existing fields in codersdk as deprecated
1 parent 0ace55a commit e371069

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

codersdk/workspaceapps.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,14 @@ type WorkspaceAppStatus struct {
106106
AgentID uuid.UUID `json:"agent_id" format:"uuid"`
107107
AppID uuid.UUID `json:"app_id" format:"uuid"`
108108
State WorkspaceAppStatusState `json:"state"`
109-
Message string `json:"message"`
109+
// Deprecated: This field is unused and will be removed in a future version.
110+
NeedsUserAttention bool `json:"needs_user_attention"`
111+
Message string `json:"message"`
110112
// URI is the URI of the resource that the status is for.
111113
// e.g. https://github.com/org/repo/pull/123
112114
// e.g. file:///path/to/file
113115
URI string `json:"uri"`
116+
// Icon is an external URL to an icon that will be rendered in the UI.
117+
// Deprecated: This field is unused and will be removed in a future version.
118+
Icon string `json:"icon"`
114119
}

site/src/api/typesGenerated.ts

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

site/src/testHelpers/entities.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -987,6 +987,9 @@ export const MockWorkspaceAppStatus: TypesGen.WorkspaceAppStatus = {
987987
uri: "https://github.com/coder/coder/pull/1234",
988988
message: "Your competitors page is completed!",
989989
state: "complete",
990+
// Deprecated fields
991+
needs_user_attention: false,
992+
icon: "deprecated",
990993
};
991994

992995
export const MockWorkspaceAgentDisconnected: TypesGen.WorkspaceAgent = {

0 commit comments

Comments
 (0)