Skip to content

Commit ef836de

Browse files
coadlercoadler
authored
fix: document workspace filter query param correctly (#8408)
1 parent cee8fde commit ef836de

File tree

4 files changed

+24
-113
lines changed

4 files changed

+24
-113
lines changed

‎coderd/apidoc/docs.go

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

‎coderd/apidoc/swagger.json

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

‎coderd/workspaces.go

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,9 @@ func (api *API) workspace(rw http.ResponseWriter, r *http.Request) {
102102
// @Security CoderSessionToken
103103
// @Produce json
104104
// @Tags Workspaces
105-
// @Param owner query string false "Filter by owner username"
106-
// @Param template query string false "Filter by template name"
107-
// @Param name query string false "Filter with partial-match by workspace name"
108-
// @Param status query string false "Filter by workspace status" Enums(pending,running,stopping,stopped,failed,canceling,canceled,deleted,deleting)
109-
// @Param has_agent query string false "Filter by agent status" Enums(connected,connecting,disconnected,timeout)
110-
// @Param deleting_by query string false "Filter workspaces scheduled to be deleted by this time"
105+
// @Param q query string false "Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, deleting_by."
106+
// @Param limit query int false "Page limit"
107+
// @Param offset query int false "Page offset"
111108
// @Success 200 {object} codersdk.WorkspacesResponse
112109
// @Router /workspaces [get]
113110
func (api *API) workspaces(rw http.ResponseWriter, r *http.Request) {

‎docs/api/workspaces.md

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -409,32 +409,11 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
409409

410410
### Parameters
411411

412-
| Name | In | Type | Required | Description |
413-
| ------------- | ----- | ------ | -------- | ------------------------------------------------------ |
414-
| `owner` | query | string | false | Filter by owner username |
415-
| `template` | query | string | false | Filter by template name |
416-
| `name` | query | string | false | Filter with partial-match by workspace name |
417-
| `status` | query | string | false | Filter by workspace status |
418-
| `has_agent` | query | string | false | Filter by agent status |
419-
| `deleting_by` | query | string | false | Filter workspaces scheduled to be deleted by this time |
420-
421-
#### Enumerated Values
422-
423-
| Parameter | Value |
424-
| ----------- | -------------- |
425-
| `status` | `pending` |
426-
| `status` | `running` |
427-
| `status` | `stopping` |
428-
| `status` | `stopped` |
429-
| `status` | `failed` |
430-
| `status` | `canceling` |
431-
| `status` | `canceled` |
432-
| `status` | `deleted` |
433-
| `status` | `deleting` |
434-
| `has_agent` | `connected` |
435-
| `has_agent` | `connecting` |
436-
| `has_agent` | `disconnected` |
437-
| `has_agent` | `timeout` |
412+
| Name | In | Type | Required | Description |
413+
| -------- | ----- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
414+
| `q` | query | string | false | Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, deleting_by. |
415+
| `limit` | query | integer | false | Page limit |
416+
| `offset` | query | integer | false | Page offset |
438417

439418
### Example responses
440419

0 commit comments

Comments
 (0)