From 8d7575118facde9a3a8226f550caba1812094e0a Mon Sep 17 00:00:00 2001 From: Eric Date: Tue, 26 Nov 2024 00:42:51 +0000 Subject: [PATCH] fix(api): update /builds transition example --- coderd/apidoc/docs.go | 1 - coderd/apidoc/swagger.json | 2 +- codersdk/workspaces.go | 2 +- docs/reference/api/builds.md | 2 +- docs/reference/api/schemas.md | 3 +-- 5 files changed, 4 insertions(+), 6 deletions(-) diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index c17ac6d3cf84a..9db467d3a9404 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -10240,7 +10240,6 @@ const docTemplate = `{ }, "transition": { "enum": [ - "create", "start", "stop", "delete" diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index 24933112d9b8b..af7cfd964936b 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -9114,7 +9114,7 @@ "format": "uuid" }, "transition": { - "enum": ["create", "start", "stop", "delete"], + "enum": ["start", "stop", "delete"], "allOf": [ { "$ref": "#/definitions/codersdk.WorkspaceTransition" diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go index d6f3e30a92979..bd94647382452 100644 --- a/codersdk/workspaces.go +++ b/codersdk/workspaces.go @@ -93,7 +93,7 @@ const ( // CreateWorkspaceBuildRequest provides options to update the latest workspace build. type CreateWorkspaceBuildRequest struct { TemplateVersionID uuid.UUID `json:"template_version_id,omitempty" format:"uuid"` - Transition WorkspaceTransition `json:"transition" validate:"oneof=create start stop delete,required"` + Transition WorkspaceTransition `json:"transition" validate:"oneof=start stop delete,required"` DryRun bool `json:"dry_run,omitempty"` ProvisionerState []byte `json:"state,omitempty"` // Orphan may be set for the Destroy transition. diff --git a/docs/reference/api/builds.md b/docs/reference/api/builds.md index fc7ecdaa5d570..1a03888508e3b 100644 --- a/docs/reference/api/builds.md +++ b/docs/reference/api/builds.md @@ -1458,7 +1458,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \ ], "state": [0], "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1", - "transition": "create" + "transition": "start" } ``` diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md index bfc923295eaeb..211dc9297f0fc 100644 --- a/docs/reference/api/schemas.md +++ b/docs/reference/api/schemas.md @@ -1400,7 +1400,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in ], "state": [0], "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1", - "transition": "create" + "transition": "start" } ``` @@ -1421,7 +1421,6 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in | Property | Value | | ------------ | -------- | | `log_level` | `debug` | -| `transition` | `create` | | `transition` | `start` | | `transition` | `stop` | | `transition` | `delete` |