synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-03 16:13:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Colin Adler
2023-07-10 13:57:09 -05:00
committed by GitHub
parent cee8fde93d
commit ef836de330
4 changed files with 24 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
coderd/apidoc/docs.go generated
View File

@ -5396,55 +5396,20 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"description": "Filter by owner username",
"name": "owner",
"description": "Search query in the format ` + "`" + `key:value` + "`" + `. Available keys are: owner, template, name, status, has-agent, deleting_by.",
"name": "q",
"in": "query"
},
{
"type": "string",
"description": "Filter by template name",
"name": "template",
"type": "integer",
"description": "Page limit",
"name": "limit",
"in": "query"
},
{
"type": "string",
"description": "Filter with partial-match by workspace name",
"name": "name",
"in": "query"
},
{
"enum": [
"pending",
"running",
"stopping",
"stopped",
"failed",
"canceling",
"canceled",
"deleted",
"deleting"
],
"type": "string",
"description": "Filter by workspace status",
"name": "status",
"in": "query"
},
{
"enum": [
"connected",
"connecting",
"disconnected",
"timeout"
],
"type": "string",
"description": "Filter by agent status",
"name": "has_agent",
"in": "query"
},
{
"type": "string",
"description": "Filter workspaces scheduled to be deleted by this time",
"name": "deleting_by",
"type": "integer",
"description": "Page offset",
"name": "offset",
"in": "query"
}
],