From 0d0c6e53ba720a26a0a023a0ce842a2bc8230057 Mon Sep 17 00:00:00 2001 From: david-fraley <67079030+david-fraley@users.noreply.github.com> Date: Wed, 5 Aug 2026 17:17:59 -0500 Subject: [PATCH] fix(coderd): document HTTP 201 for workspace and build creation (#27903) --- coderd/apidoc/docs.go | 12 ++++++------ coderd/apidoc/swagger.json | 12 ++++++------ coderd/workspacebuilds.go | 2 +- coderd/workspaces.go | 4 ++-- docs/reference/api/builds.md | 8 ++++---- docs/reference/api/workspaces.md | 16 ++++++++-------- 6 files changed, 27 insertions(+), 27 deletions(-) diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index 039935a828..5816027220 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -5684,8 +5684,8 @@ const docTemplate = `{ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/codersdk.Workspace" } @@ -11752,8 +11752,8 @@ const docTemplate = `{ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/codersdk.Workspace" } @@ -13979,8 +13979,8 @@ const docTemplate = `{ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/codersdk.WorkspaceBuild" } diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index fedd85615a..1ec365ae8e 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -5029,8 +5029,8 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/codersdk.Workspace" } @@ -10429,8 +10429,8 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/codersdk.Workspace" } @@ -12407,8 +12407,8 @@ } ], "responses": { - "200": { - "description": "OK", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/codersdk.WorkspaceBuild" } diff --git a/coderd/workspacebuilds.go b/coderd/workspacebuilds.go index 9678defee5..32b45bd6f9 100644 --- a/coderd/workspacebuilds.go +++ b/coderd/workspacebuilds.go @@ -323,7 +323,7 @@ func (api *API) workspaceBuildByBuildNumber(rw http.ResponseWriter, r *http.Requ // @Tags Builds // @Param workspace path string true "Workspace ID" format(uuid) // @Param request body codersdk.CreateWorkspaceBuildRequest true "Create workspace build request" -// @Success 200 {object} codersdk.WorkspaceBuild +// @Success 201 {object} codersdk.WorkspaceBuild // @Router /api/v2/workspaces/{workspace}/builds [post] func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) { ctx := r.Context() diff --git a/coderd/workspaces.go b/coderd/workspaces.go index eb89dc723c..8d9c8bde7c 100644 --- a/coderd/workspaces.go +++ b/coderd/workspaces.go @@ -364,7 +364,7 @@ func (api *API) workspaceByOwnerAndName(rw http.ResponseWriter, r *http.Request) // @Param organization path string true "Organization ID" format(uuid) // @Param user path string true "Username, UUID, or me" // @Param request body codersdk.CreateWorkspaceRequest true "Create workspace request" -// @Success 200 {object} codersdk.Workspace +// @Success 201 {object} codersdk.Workspace // @Router /api/v2/organizations/{organization}/members/{user}/workspaces [post] func (api *API) postWorkspacesByOrganization(rw http.ResponseWriter, r *http.Request) { var ( @@ -425,7 +425,7 @@ func (api *API) postWorkspacesByOrganization(rw http.ResponseWriter, r *http.Req // @Tags Workspaces // @Param user path string true "Username, UUID, or me" // @Param request body codersdk.CreateWorkspaceRequest true "Create workspace request" -// @Success 200 {object} codersdk.Workspace +// @Success 201 {object} codersdk.Workspace // @Router /api/v2/users/{user}/workspaces [post] func (api *API) postUserWorkspaces(rw http.ResponseWriter, r *http.Request) { var ( diff --git a/docs/reference/api/builds.md b/docs/reference/api/builds.md index cc61c88742..cbd7934314 100644 --- a/docs/reference/api/builds.md +++ b/docs/reference/api/builds.md @@ -1804,7 +1804,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \ ### Example responses -> 200 Response +> 201 Response ```json { @@ -2020,8 +2020,8 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \ ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | +| Status | Meaning | Description | Schema | +|--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------| +| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | To perform this operation, you must be authenticated. [Learn more](authentication.md). diff --git a/docs/reference/api/workspaces.md b/docs/reference/api/workspaces.md index 92ea4d72fe..80e7959ff3 100644 --- a/docs/reference/api/workspaces.md +++ b/docs/reference/api/workspaces.md @@ -49,7 +49,7 @@ of the template will be used. ### Example responses -> 200 Response +> 201 Response ```json { @@ -328,9 +328,9 @@ of the template will be used. ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | +| Status | Meaning | Description | Schema | +|--------|--------------------------------------------------------------|-------------|----------------------------------------------------| +| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Workspace](schemas.md#codersdkworkspace) | To perform this operation, you must be authenticated. [Learn more](authentication.md). @@ -748,7 +748,7 @@ of the template will be used. ### Example responses -> 200 Response +> 201 Response ```json { @@ -1027,9 +1027,9 @@ of the template will be used. ### Responses -| Status | Meaning | Description | Schema | -|--------|---------------------------------------------------------|-------------|----------------------------------------------------| -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | +| Status | Meaning | Description | Schema | +|--------|--------------------------------------------------------------|-------------|----------------------------------------------------| +| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Workspace](schemas.md#codersdkworkspace) | To perform this operation, you must be authenticated. [Learn more](authentication.md).