synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-06 15:41:45 +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"
}
],

46
coderd/apidoc/swagger.json generated
View File

@ -4752,50 +4752,20 @@
"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"
}
],

9
coderd/workspaces.go
View File

@ -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) {