fix: document workspace filter query param correctly (coder#8408)

Author: coadler

coderd/apidoc/docs.go

@@ -102,12 +102,9 @@ func (api *API) workspace(rw http.ResponseWriter, r *http.Request) {
 // @Security CoderSessionToken
 // @Produce json
 // @Tags Workspaces
-// @Param owner query string false "Filter by owner username"
-// @Param template query string false "Filter by template name"
-// @Param name query string false "Filter with partial-match by workspace name"
-// @Param status query string false "Filter by workspace status" Enums(pending,running,stopping,stopped,failed,canceling,canceled,deleted,deleting)
-// @Param has_agent query string false "Filter by agent status" Enums(connected,connecting,disconnected,timeout)
-// @Param deleting_by query string false "Filter workspaces scheduled to be deleted by this time"
+// @Param q query string false "Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, deleting_by."
+// @Param limit query int false "Page limit"
+// @Param offset query int false "Page offset"
 // @Success 200 {object} codersdk.WorkspacesResponse
 // @Router /workspaces [get]
 func (api *API) workspaces(rw http.ResponseWriter, r *http.Request) {

coderd/apidoc/swagger.json

@@ -409,32 +409,11 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
 
 ### Parameters
 
-| Name          | In    | Type   | Required | Description                                            |
-| ------------- | ----- | ------ | -------- | ------------------------------------------------------ |
-| `owner`       | query | string | false    | Filter by owner username                               |
-| `template`    | query | string | false    | Filter by template name                                |
-| `name`        | query | string | false    | Filter with partial-match by workspace name            |
-| `status`      | query | string | false    | Filter by workspace status                             |
-| `has_agent`   | query | string | false    | Filter by agent status                                 |
-| `deleting_by` | query | string | false    | Filter workspaces scheduled to be deleted by this time |
-
-#### Enumerated Values
-
-| Parameter   | Value          |
-| ----------- | -------------- |
-| `status`    | `pending`      |
-| `status`    | `running`      |
-| `status`    | `stopping`     |
-| `status`    | `stopped`      |
-| `status`    | `failed`       |
-| `status`    | `canceling`    |
-| `status`    | `canceled`     |
-| `status`    | `deleted`      |
-| `status`    | `deleting`     |
-| `has_agent` | `connected`    |
-| `has_agent` | `connecting`   |
-| `has_agent` | `disconnected` |
-| `has_agent` | `timeout`      |
+| Name     | In    | Type    | Required | Description                                                                                                        |
+| -------- | ----- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
+| `q`      | query | string  | false    | Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, deleting_by. |
+| `limit`  | query | integer | false    | Page limit                                                                                                         |
+| `offset` | query | integer | false    | Page offset                                                                                                        |
 
 ### Example responses