Fix: include deleted

mtojek · mtojek · commit e4db9368cd51 · 2022-12-15T17:44:44.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -228,7 +228,7 @@ const docTemplate = `{
                     },
                     {
                         "type": "string",
-                        "description": "Include deleted",
+                        "description": "Return data instead of HTTP 404 if the workspace is deleted",
                         "name": "include_deleted",
                         "in": "query"
                     }
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -220,7 +220,7 @@
                     },
                     {
                         "type": "string",
-                        "description": "Include deleted",
+                        "description": "Return data instead of HTTP 404 if the workspace is deleted",
                         "name": "include_deleted",
                         "in": "query"
                     }
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -49,7 +49,7 @@ var (
 // @Produce json
 // @Tags Workspaces
 // @Param id path string true "Workspace ID" format(uuid)
-// @Param include_deleted query string false "Include deleted"
+// @Param include_deleted query string false "Return data instead of HTTP 404 if the workspace is deleted"
 // @Success 200 {object} codersdk.Workspace
 // @Failure 400 {object} codersdk.Response
 // @Failure 404 {object} codersdk.Response
diff --git a/docs/api/workspaces.md b/docs/api/workspaces.md
@@ -187,10 +187,10 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{id} \
 
 ### Parameters
 
-| Name            | In    | Type         | Required | Description     |
-| --------------- | ----- | ------------ | -------- | --------------- |
-| id              | path  | string(uuid) | true     | Workspace ID    |
-| include_deleted | query | string       | false    | Include deleted |
+| Name            | In    | Type         | Required | Description                                                 |
+| --------------- | ----- | ------------ | -------- | ----------------------------------------------------------- |
+| id              | path  | string(uuid) | true     | Workspace ID                                                |
+| include_deleted | query | string       | false    | Return data instead of HTTP 404 if the workspace is deleted |
 
 ### Example responses
 

Original file line number	Diff line number	Diff line change
@@ -228,7 +228,7 @@ const docTemplate = `{
`228`	`228`	`},`
`229`	`229`	`{`
`230`	`230`	`"type": "string",`
`231`		`- "description": "Include deleted",`
	`231`	`+ "description": "Return data instead of HTTP 404 if the workspace is deleted",`
`232`	`232`	`"name": "include_deleted",`
`233`	`233`	`"in": "query"`
`234`	`234`	`}`
Original file line number	Diff line number	Diff line change
`@@ -220,7 +220,7 @@`
`220`	`220`	`},`
`221`	`221`	`{`
`222`	`222`	`"type": "string",`
`223`		`- "description": "Include deleted",`
	`223`	`+ "description": "Return data instead of HTTP 404 if the workspace is deleted",`
`224`	`224`	`"name": "include_deleted",`
`225`	`225`	`"in": "query"`
`226`	`226`	`}`