Commit101cf64

committed

mark fields of PatchAppStatus as deprecated

1 parent4e924af commit101cf64Copy full SHA for 101cf64

File tree

+20

-11

lines changed

+20

-11

lines changed

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -366,8 +366,10 @@ func TestWorkspaceAgentAppStatus(t *testing.T) {`
`366`	`366`	`AppSlug:"vscode",`
`367`	`367`	`Message:"testing",`
`368`	`368`	`URI:"https://example.com",`
`369`		`-Icon:"https://example.com/icon.png",`
`370`	`369`	`State:codersdk.WorkspaceAppStatusStateComplete,`
	`370`	`+// Ensure deprecated fields are ignored.`
	`371`	`+Icon:"https://example.com/icon.png",`
	`372`	`+NeedsUserAttention:true,`
`371`	`373`	`})`
`372`	`374`	`require.NoError(t,err)`
`373`	`375`
`@@ -376,6 +378,9 @@ func TestWorkspaceAgentAppStatus(t *testing.T) {`
`376`	`378`	`agent,err:=client.WorkspaceAgent(ctx,workspace.LatestBuild.Resources[0].Agents[0].ID)`
`377`	`379`	`require.NoError(t,err)`
`378`	`380`	`require.Len(t,agent.Apps[0].Statuses,1)`
	`381`	`+// Deprecated fields should be ignored.`
	`382`	`+require.Empty(t,agent.Apps[0].Statuses[0].Icon)`
	`383`	`+require.False(t,agent.Apps[0].Statuses[0].NeedsUserAttention)`
`379`	`384`	`})`
`380`	`385`	`}`
`381`	`386`

Lines changed: 8 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -583,12 +583,14 @@ func (c *Client) PatchLogs(ctx context.Context, req PatchLogs) error {`
`583`	`583`
`584`	`584`	`// PatchAppStatus updates the status of a workspace app.`
`585`	`585`	`typePatchAppStatusstruct {`
`586`		-AppSlugstring`json:"app_slug"`
`587`		-NeedsUserAttentionbool`json:"needs_user_attention"`
`588`		-State codersdk.WorkspaceAppStatusState`json:"state"`
`589`		-Messagestring`json:"message"`
`590`		-URIstring`json:"uri"`
`591`		-Iconstring`json:"icon"`
	`586`	+AppSlugstring`json:"app_slug"`
	`587`	+State codersdk.WorkspaceAppStatusState`json:"state"`
	`588`	+Messagestring`json:"message"`
	`589`	+URIstring`json:"uri"`
	`590`	`+// Deprecated: this field is unused and will be removed in a future version.`
	`591`	+Iconstring`json:"icon"`
	`592`	`+// Deprecated: this field is unused and will be removed in a future version.`
	`593`	+NeedsUserAttentionbool`json:"needs_user_attention"`
`592`	`594`	`}`
`593`	`595`
`594`	`596`	`func (c*Client)PatchAppStatus(ctx context.Context,reqPatchAppStatus)error {`

Lines changed: 6 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -106,14 +106,16 @@ type WorkspaceAppStatus struct {`
`106`	`106`	AgentID uuid.UUID`json:"agent_id" format:"uuid"`
`107`	`107`	AppID uuid.UUID`json:"app_id" format:"uuid"`
`108`	`108`	StateWorkspaceAppStatusState`json:"state"`
`109`		`-// Deprecated: This field is unused and will be removed in a future version.`
`110`		-NeedsUserAttentionbool`json:"needs_user_attention"`
`111`		-Messagestring`json:"message"`
	`109`	+Messagestring`json:"message"`
`112`	`110`	`// URI is the URI of the resource that the status is for.`
`113`	`111`	`// e.g. https://github.com/org/repo/pull/123`
`114`	`112`	`// e.g. file:///path/to/file`
`115`	`113`	URIstring`json:"uri"`
`116`		`-// Icon is an external URL to an icon that will be rendered in the UI.`
	`114`	`+`
`117`	`115`	`// Deprecated: This field is unused and will be removed in a future version.`
	`116`	`+// Icon is an external URL to an icon that will be rendered in the UI.`
`118`	`117`	Iconstring`json:"icon"`
	`118`	`+// Deprecated: This field is unused and will be removed in a future version.`
	`119`	`+// NeedsUserAttention specifies whether the status needs user attention.`
	`120`	+NeedsUserAttentionbool`json:"needs_user_attention"`
`119`	`121`	`}`

Comments

(0)