opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(codersdk): deprecate WorkspaceAppStatus.{NeedsUserAttention,Icon} (#17358)

Browse Source 
https://github.com/coder/coder/pull/17163 introduced the
`workspace_app_statuses` table. Two of these fields
(`needs_user_attention`, `icon`) turned out to be surplus to
requirements.

- Removes columns `needs_user_attention` and `icon` from
`workspace_app_statuses`
- Marks the corresponding fields of `codersdk.WorkspaceAppStatus` as
deprecated.
This commit is contained in:
Cian Johnston
2025-04-15 10:47:42 +01:00
committed by GitHub
parent 95f03c561f
commit 979687c37f
21 changed files with 119 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/api/builds.md
Generated
+4 -4
View File
@@ -818,10 +818,10 @@ Status Code **200**
| `»»»» agent_id` | string(uuid) | false | | |
| `»»»» app_id` | string(uuid) | false | | |
| `»»»» created_at` | string(date-time) | false | | |
| `»»»» icon` | string | false | | Icon is an external URL to an icon that will be rendered in the UI. |
| `»»»» icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. |
| `»»»» id` | string(uuid) | false | | |
| `»»»» message` | string | false | | |
| `»»»» needs_user_attention` | boolean | false | | |
| `»»»» needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. |
| `»»»» state` | [codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate) | false | | |
| `»»»» uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file |
| `»»»» workspace_id` | string(uuid) | false | | |
@@ -1532,10 +1532,10 @@ Status Code **200**
| `»»»»» agent_id` | string(uuid) | false | | |
| `»»»»» app_id` | string(uuid) | false | | |
| `»»»»» created_at` | string(date-time) | false | | |
| `»»»»» icon` | string | false | | Icon is an external URL to an icon that will be rendered in the UI. |
| `»»»»» icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. |
| `»»»»» id` | string(uuid) | false | | |
| `»»»»» message` | string | false | | |
| `»»»»» needs_user_attention` | boolean | false | | |
| `»»»»» needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. |
| `»»»»» state` | [codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate) | false | | |
| `»»»»» uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file |
| `»»»»» workspace_id` | string(uuid) | false | | |
docs/reference/api/schemas.md
Generated
+20 -20
View File
@@ -133,14 +133,14 @@
### Properties
| Name | Type | Required | Restrictions | Description |
|------------------------|----------------------------------------------------------------------|----------|--------------|-------------|
| `app_slug` | string | false | | |
| `icon` | string | false | | |
| `message` | string | false | | |
| `needs_user_attention` | boolean | false | | |
| `state` | [codersdk.WorkspaceAppStatusState](#codersdkworkspaceappstatusstate) | false | | |
| `uri` | string | false | | |
| Name | Type | Required | Restrictions | Description |
|------------------------|----------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------|
| `app_slug` | string | false | | |
| `icon` | string | false | | Deprecated: this field is unused and will be removed in a future version. |
| `message` | string | false | | |
| `needs_user_attention` | boolean | false | | Deprecated: this field is unused and will be removed in a future version. |
| `state` | [codersdk.WorkspaceAppStatusState](#codersdkworkspaceappstatusstate) | false | | |
| `uri` | string | false | | |
## agentsdk.PatchLogs
@@ -8499,18 +8499,18 @@ If the schedule is empty, the user will be updated to use the default schedule.|
### Properties
| Name | Type | Required | Restrictions | Description |
|------------------------|----------------------------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------|
| `agent_id` | string | false | | |
| `app_id` | string | false | | |
| `created_at` | string | false | | |
| `icon` | string | false | | Icon is an external URL to an icon that will be rendered in the UI. |
| `id` | string | false | | |
| `message` | string | false | | |
| `needs_user_attention` | boolean | false | | |
| `state` | [codersdk.WorkspaceAppStatusState](#codersdkworkspaceappstatusstate) | false | | |
| `uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file |
| `workspace_id` | string | false | | |
| Name | Type | Required | Restrictions | Description |
|------------------------|----------------------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `agent_id` | string | false | | |
| `app_id` | string | false | | |
| `created_at` | string | false | | |
| `icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. |
| `id` | string | false | | |
| `message` | string | false | | |
| `needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. |
| `state` | [codersdk.WorkspaceAppStatusState](#codersdkworkspaceappstatusstate) | false | | |
| `uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file |
| `workspace_id` | string | false | | |
## codersdk.WorkspaceAppStatusState
docs/reference/api/templates.md
Generated
+4 -4
View File
@@ -2429,10 +2429,10 @@ Status Code **200**
| `»»»» agent_id` | string(uuid) | false | | |
| `»»»» app_id` | string(uuid) | false | | |
| `»»»» created_at` | string(date-time) | false | | |
| `»»»» icon` | string | false | | Icon is an external URL to an icon that will be rendered in the UI. |
| `»»»» icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. |
| `»»»» id` | string(uuid) | false | | |
| `»»»» message` | string | false | | |
| `»»»» needs_user_attention` | boolean | false | | |
| `»»»» needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. |
| `»»»» state` | [codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate) | false | | |
| `»»»» uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file |
| `»»»» workspace_id` | string(uuid) | false | | |
@@ -2976,10 +2976,10 @@ Status Code **200**
| `»»»» agent_id` | string(uuid) | false | | |
| `»»»» app_id` | string(uuid) | false | | |
| `»»»» created_at` | string(date-time) | false | | |
| `»»»» icon` | string | false | | Icon is an external URL to an icon that will be rendered in the UI. |
| `»»»» icon` | string | false | | Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI. |
| `»»»» id` | string(uuid) | false | | |
| `»»»» message` | string | false | | |
| `»»»» needs_user_attention` | boolean | false | | |
| `»»»» needs_user_attention` | boolean | false | | Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention. |
| `»»»» state` | [codersdk.WorkspaceAppStatusState](schemas.md#codersdkworkspaceappstatusstate) | false | | |
| `»»»» uri` | string | false | | Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file |
| `»»»» workspace_id` | string(uuid) | false | | |