diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index f49b91832f..412d11f2f8 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -6368,8 +6368,9 @@ const docTemplate = `{ "tags": [ "Builds" ], - "summary": "Get workspace resources for workspace build", - "operationId": "get-workspace-resources-for-workspace-build", + "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 1852fd9b5a..7b8457ae42 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -5618,8 +5618,9 @@ ], "produces": ["application/json"], "tags": ["Builds"], - "summary": "Get workspace resources for workspace build", - "operationId": "get-workspace-resources-for-workspace-build", + "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/coderd.go b/coderd/coderd.go index 5a8c8d828d..6110733ede 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 3d37351efa..762b5bc931 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,27 @@ func (api *API) workspaceAgentPostMetadataDeprecated(rw http.ResponseWriter, r * httpapi.Write(ctx, rw, http.StatusNoContent, nil) } + +// @Summary Removed: Get workspace resources for workspace build +// @ID removed-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] +// @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) + + 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 55ab6a5c29..40514cb913 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 diff --git a/docs/api/builds.md b/docs/api/builds.md index 3b7a708003..8cad5b3a73 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**