selfhosted
/
coder
mirror of https://github.com/coder/coder.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: deprecate API workspace build resources (#12167)

This commit is contained in:
Marcin Tojek 2024-02-15 17:13:44 +01:00 committed by GitHub
parent 2aff014e5d
commit 5aa5ff1bde
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 34 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
coderd/apidoc/docs.go generated
View File

@ -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",

5
coderd/apidoc/swagger.json generated
View File

@ -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",

2
coderd/coderd.go
View File

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

25
coderd/deprecated.go
View File

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

23
coderd/workspacebuilds.go
View File

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

4
docs/api/builds.md generated
View File

@ -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) |
<h3 id="get-workspace-resources-for-workspace-build-responseschema">Response Schema</h3>
<h3 id="removed:-get-workspace-resources-for-workspace-build-responseschema">Response Schema</h3>
Status Code **200**