Skip to content

Commit e310b79

Browse files
mtojekmtojek
committed
Fix: improve workspaces
1 parent c090ef8 commit e310b79

File tree

4 files changed

+76
-38
lines changed

4 files changed

+76
-38
lines changed

‎coderd/apidoc/docs.go

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -145,37 +145,48 @@ const docTemplate = `{
145145
"parameters": [
146146
{
147147
"type": "string",
148-
"description": "Owner username",
148+
"description": "Filter by owner username",
149149
"name": "owner",
150150
"in": "query"
151151
},
152152
{
153153
"type": "string",
154-
"description": "Template name",
154+
"description": "Filter by template name",
155155
"name": "template",
156156
"in": "query"
157157
},
158158
{
159159
"type": "string",
160-
"description": "Workspace name",
160+
"description": "Filter with partial-match by workspace name",
161161
"name": "name",
162162
"in": "query"
163163
},
164164
{
165+
"enum": [
166+
"pending",
167+
"running",
168+
"stopping",
169+
"stopped",
170+
"failed",
171+
"canceling",
172+
"canceled",
173+
"deleted",
174+
"deleting"
175+
],
165176
"type": "string",
166-
"description": "Workspace status",
177+
"description": "Filter by workspace status",
167178
"name": "status",
168179
"in": "query"
169180
},
170181
{
171-
"type": "boolean",
172-
"description": "Deleted workspaces",
173-
"name": "deleted",
174-
"in": "query"
175-
},
176-
{
177-
"type": "boolean",
178-
"description": "Has agent",
182+
"enum": [
183+
"connected",
184+
"connecting",
185+
"disconnected",
186+
"timeout"
187+
],
188+
"type": "string",
189+
"description": "Filter by agent status",
179190
"name": "has_agent",
180191
"in": "query"
181192
}

‎coderd/apidoc/swagger.json

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -137,37 +137,48 @@
137137
"parameters": [
138138
{
139139
"type": "string",
140-
"description": "Owner username",
140+
"description": "Filter by owner username",
141141
"name": "owner",
142142
"in": "query"
143143
},
144144
{
145145
"type": "string",
146-
"description": "Template name",
146+
"description": "Filter by template name",
147147
"name": "template",
148148
"in": "query"
149149
},
150150
{
151151
"type": "string",
152-
"description": "Workspace name",
152+
"description": "Filter with partial-match by workspace name",
153153
"name": "name",
154154
"in": "query"
155155
},
156156
{
157+
"enum": [
158+
"pending",
159+
"running",
160+
"stopping",
161+
"stopped",
162+
"failed",
163+
"canceling",
164+
"canceled",
165+
"deleted",
166+
"deleting"
167+
],
157168
"type": "string",
158-
"description": "Workspace status",
169+
"description": "Filter by workspace status",
159170
"name": "status",
160171
"in": "query"
161172
},
162173
{
163-
"type": "boolean",
164-
"description": "Deleted workspaces",
165-
"name": "deleted",
166-
"in": "query"
167-
},
168-
{
169-
"type": "boolean",
170-
"description": "Has agent",
174+
"enum": [
175+
"connected",
176+
"connecting",
177+
"disconnected",
178+
"timeout"
179+
],
180+
"type": "string",
181+
"description": "Filter by agent status",
171182
"name": "has_agent",
172183
"in": "query"
173184
}

‎coderd/workspaces.go

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,11 @@ func (api *API) workspace(rw http.ResponseWriter, r *http.Request) {
110110
// @Security CoderSessionToken
111111
// @Produce json
112112
// @Tags Workspaces
113-
// @Param owner query string false "Owner username"
114-
// @Param template query string false "Template name"
115-
// @Param name query string false "Workspace name"
116-
// @Param status query string false "Workspace status"
117-
// @Param deleted query bool false "Deleted workspaces"
118-
// @Param has_agent query bool false "Has agent"
113+
// @Param owner query string false "Filter by owner username"
114+
// @Param template query string false "Filter by template name"
115+
// @Param name query string false "Filter with partial-match by workspace name"
116+
// @Param status query string false "Filter by workspace status" Enums(pending,running,stopping,stopped,failed,canceling,canceled,deleted,deleting)
117+
// @Param has_agent query string false "Filter by agent status" Enums(connected,connecting,disconnected,timeout)
119118
// @Success 200 {object} codersdk.WorkspacesResponse
120119
// @Failure 400 {object} codersdk.Response
121120
// @Failure 500 {object} codersdk.Response

‎docs/api/workspaces.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,31 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
1616

1717
### Parameters
1818

19-
| Name | In | Type | Required | Description |
20-
| --------- | ----- | ------- | -------- | ------------------ |
21-
| owner | query | string | false | Owner username |
22-
| template | query | string | false | Template name |
23-
| name | query | string | false | Workspace name |
24-
| status | query | string | false | Workspace status |
25-
| deleted | query | boolean | false | Deleted workspaces |
26-
| has_agent | query | boolean | false | Has agent |
19+
| Name | In | Type | Required | Description |
20+
| --------- | ----- | ------ | -------- | ------------------------------------------- |
21+
| owner | query | string | false | Filter by owner username |
22+
| template | query | string | false | Filter by template name |
23+
| name | query | string | false | Filter with partial-match by workspace name |
24+
| status | query | string | false | Filter by workspace status |
25+
| has_agent | query | string | false | Filter by agent status |
26+
27+
#### Enumerated Values
28+
29+
| Parameter | Value |
30+
| --------- | ------------ |
31+
| status | pending |
32+
| status | running |
33+
| status | stopping |
34+
| status | stopped |
35+
| status | failed |
36+
| status | canceling |
37+
| status | canceled |
38+
| status | deleted |
39+
| status | deleting |
40+
| has_agent | connected |
41+
| has_agent | connecting |
42+
| has_agent | disconnected |
43+
| has_agent | timeout |
2744

2845
### Example responses
2946

0 commit comments

Comments
 (0)