From 09b693105136e2b014c354987f0284fede498578 Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Thu, 15 Feb 2024 14:21:21 +0100 Subject: [PATCH 1/4] deprecated --- coderd/coderd.go | 2 +- coderd/deprecated.go | 24 ++++++++++++++++++++++++ coderd/workspacebuilds.go | 23 ----------------------- 3 files changed, 25 insertions(+), 24 deletions(-) diff --git a/coderd/coderd.go b/coderd/coderd.go index 5a8c8d828da8c..6110733edecc3 100644 --- a/coderd/coderd.go +++ b/coderd/coderd.go @@ -992,7 +992,7 @@ func New(options *Options) *API { r.Patch("/cancel", api.patchCancelWorkspaceBuild) r.Get("/logs", api.workspaceBuildLogs) r.Get("/parameters", api.workspaceBuildParameters) - r.Get("/resources", api.workspaceBuildResources) + r.Get("/resources", api.workspaceBuildResourcesDeprecated) r.Get("/state", api.workspaceBuildState) }) r.Route("/authcheck", func(r chi.Router) { diff --git a/coderd/deprecated.go b/coderd/deprecated.go index 3d37351efa3a9..a700fa92f1ebf 100644 --- a/coderd/deprecated.go +++ b/coderd/deprecated.go @@ -8,6 +8,7 @@ import ( "cdr.dev/slog" "github.com/coder/coder/v2/coderd/httpapi" "github.com/coder/coder/v2/coderd/httpmw" + "github.com/coder/coder/v2/codersdk" "github.com/coder/coder/v2/codersdk/agentsdk" ) @@ -114,3 +115,26 @@ func (api *API) workspaceAgentPostMetadataDeprecated(rw http.ResponseWriter, r * httpapi.Write(ctx, rw, http.StatusNoContent, nil) } + +// @Summary Removed: Get workspace resources for workspace build +// @ID get-workspace-resources-for-workspace-build +// @Security CoderSessionToken +// @Produce json +// @Tags Builds +// @Param workspacebuild path string true "Workspace build ID" +// @Success 200 {array} codersdk.WorkspaceResource +// @Router /workspacebuilds/{workspacebuild}/resources [get] +func (api *API) workspaceBuildResourcesDeprecated(rw http.ResponseWriter, r *http.Request) { + ctx := r.Context() + workspaceBuild := httpmw.WorkspaceBuildParam(r) + + job, err := api.Database.GetProvisionerJobByID(ctx, workspaceBuild.JobID) + if err != nil { + httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{ + Message: "Internal error fetching provisioner job.", + Detail: err.Error(), + }) + return + } + api.provisionerJobResources(rw, r, job) +} diff --git a/coderd/workspacebuilds.go b/coderd/workspacebuilds.go index 55ab6a5c29f80..40514cb913d86 100644 --- a/coderd/workspacebuilds.go +++ b/coderd/workspacebuilds.go @@ -557,29 +557,6 @@ func (api *API) verifyUserCanCancelWorkspaceBuilds(ctx context.Context, userID u return slices.Contains(user.RBACRoles, rbac.RoleOwner()), nil // only user with "owner" role can cancel workspace builds } -// @Summary Get workspace resources for workspace build -// @ID get-workspace-resources-for-workspace-build -// @Security CoderSessionToken -// @Produce json -// @Tags Builds -// @Param workspacebuild path string true "Workspace build ID" -// @Success 200 {array} codersdk.WorkspaceResource -// @Router /workspacebuilds/{workspacebuild}/resources [get] -func (api *API) workspaceBuildResources(rw http.ResponseWriter, r *http.Request) { - ctx := r.Context() - workspaceBuild := httpmw.WorkspaceBuildParam(r) - - job, err := api.Database.GetProvisionerJobByID(ctx, workspaceBuild.JobID) - if err != nil { - httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{ - Message: "Internal error fetching provisioner job.", - Detail: err.Error(), - }) - return - } - api.provisionerJobResources(rw, r, job) -} - // @Summary Get build parameters for workspace build // @ID get-build-parameters-for-workspace-build // @Security CoderSessionToken From d1b90b623840d39338495ec4f9d9e817b28c9582 Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Thu, 15 Feb 2024 14:13:38 +0000 Subject: [PATCH 2/4] make gen --- coderd/apidoc/docs.go | 2 +- coderd/apidoc/swagger.json | 2 +- docs/api/builds.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index f49b91832fdec..dd472b4ab3143 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -6368,7 +6368,7 @@ const docTemplate = `{ "tags": [ "Builds" ], - "summary": "Get workspace resources for workspace build", + "summary": "Removed: Get workspace resources for workspace build", "operationId": "get-workspace-resources-for-workspace-build", "parameters": [ { diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index 1852fd9b5a4ad..42340ebb7dff1 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -5618,7 +5618,7 @@ ], "produces": ["application/json"], "tags": ["Builds"], - "summary": "Get workspace resources for workspace build", + "summary": "Removed: Get workspace resources for workspace build", "operationId": "get-workspace-resources-for-workspace-build", "parameters": [ { diff --git a/docs/api/builds.md b/docs/api/builds.md index 3b7a7080033ae..8cad5b3a73bec 100644 --- a/docs/api/builds.md +++ b/docs/api/builds.md @@ -533,7 +533,7 @@ Status Code **200** To perform this operation, you must be authenticated. [Learn more](authentication.md). -## Get workspace resources for workspace build +## Removed: Get workspace resources for workspace build ### Code samples @@ -674,7 +674,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res | ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) | -

Response Schema

+

Response Schema

Status Code **200** From 16975973bf6daf4f4fa1c694b496cf9d33bd812c Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Thu, 15 Feb 2024 14:43:07 +0000 Subject: [PATCH 3/4] fix --- coderd/apidoc/docs.go | 2 +- coderd/apidoc/swagger.json | 2 +- coderd/deprecated.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index dd472b4ab3143..09b090bc91ec1 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -6369,7 +6369,7 @@ const docTemplate = `{ "Builds" ], "summary": "Removed: Get workspace resources for workspace build", - "operationId": "get-workspace-resources-for-workspace-build", + "operationId": "removed-get-workspace-resources-for-workspace-build", "parameters": [ { "type": "string", diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index 42340ebb7dff1..359c325af76e7 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -5619,7 +5619,7 @@ "produces": ["application/json"], "tags": ["Builds"], "summary": "Removed: Get workspace resources for workspace build", - "operationId": "get-workspace-resources-for-workspace-build", + "operationId": "removed-get-workspace-resources-for-workspace-build", "parameters": [ { "type": "string", diff --git a/coderd/deprecated.go b/coderd/deprecated.go index a700fa92f1ebf..b372afe08f565 100644 --- a/coderd/deprecated.go +++ b/coderd/deprecated.go @@ -117,7 +117,7 @@ func (api *API) workspaceAgentPostMetadataDeprecated(rw http.ResponseWriter, r * } // @Summary Removed: Get workspace resources for workspace build -// @ID get-workspace-resources-for-workspace-build +// @ID removed-get-workspace-resources-for-workspace-build // @Security CoderSessionToken // @Produce json // @Tags Builds From 95fd013d0cc6074beda9932bf71cb603fb5fec39 Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Thu, 15 Feb 2024 15:47:56 +0000 Subject: [PATCH 4/4] fix --- coderd/apidoc/docs.go | 1 + coderd/apidoc/swagger.json | 1 + coderd/deprecated.go | 1 + 3 files changed, 3 insertions(+) diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index 09b090bc91ec1..412d11f2f80a7 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -6370,6 +6370,7 @@ const docTemplate = `{ ], "summary": "Removed: Get workspace resources for workspace build", "operationId": "removed-get-workspace-resources-for-workspace-build", + "deprecated": true, "parameters": [ { "type": "string", diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index 359c325af76e7..7b8457ae42042 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -5620,6 +5620,7 @@ "tags": ["Builds"], "summary": "Removed: Get workspace resources for workspace build", "operationId": "removed-get-workspace-resources-for-workspace-build", + "deprecated": true, "parameters": [ { "type": "string", diff --git a/coderd/deprecated.go b/coderd/deprecated.go index b372afe08f565..762b5bc931e38 100644 --- a/coderd/deprecated.go +++ b/coderd/deprecated.go @@ -124,6 +124,7 @@ func (api *API) workspaceAgentPostMetadataDeprecated(rw http.ResponseWriter, r * // @Param workspacebuild path string true "Workspace build ID" // @Success 200 {array} codersdk.WorkspaceResource // @Router /workspacebuilds/{workspacebuild}/resources [get] +// @Deprecated this endpoint is unused and will be removed in future. func (api *API) workspaceBuildResourcesDeprecated(rw http.ResponseWriter, r *http.Request) { ctx := r.Context() workspaceBuild := httpmw.WorkspaceBuildParam(r)