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

fix: docuemnt workspace filter query param correctly (#10894)

Browse Source
This commit is contained in:
Kira Pilot
2023-11-27 12:57:24 -05:00
committed by GitHub
parent 20525c8b2e
commit 54c3fc63d9
4 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/apidoc/docs.go
Generated
+1 -1
View File
@@ -6149,7 +6149,7 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"description": "Search query in the format ` + "`" + `key:value` + "`" + `. Available keys are: owner, template, name, status, has-agent, deleting_by.",
"description": "Search query in the format ` + "`" + `key:value` + "`" + `. Available keys are: owner, template, name, status, has-agent, is-dormant, last_used_after, last_used_before.",
"name": "q",
"in": "query"
},
coderd/apidoc/swagger.json
Generated
+1 -1
View File
@@ -5419,7 +5419,7 @@
"parameters": [
{
"type": "string",
"description": "Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, deleting_by.",
"description": "Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, is-dormant, last_used_after, last_used_before.",
"name": "q",
"in": "query"
},
coderd/workspaces.go
+1 -1
View File
@@ -117,7 +117,7 @@ func (api *API) workspace(rw http.ResponseWriter, r *http.Request) {
// @Security CoderSessionToken
// @Produce json
// @Tags Workspaces
// @Param q query string false "Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, deleting_by."
// @Param q query string false "Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, is-dormant, last_used_after, last_used_before."
// @Param limit query int false "Page limit"
// @Param offset query int false "Page offset"
// @Success 200 {object} codersdk.WorkspacesResponse
docs/api/workspaces.md
Generated
+5 -5
View File
@@ -455,11 +455,11 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
### Parameters
| 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 |
| 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, is-dormant, last_used_after, last_used_before. |
| `limit` | query | integer | false | Page limit |
| `offset` | query | integer | false | Page offset |
### Example responses