diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go index 04b0a93cfb12e..dcb7eba98b653 100644 --- a/coderd/apidoc/docs.go +++ b/coderd/apidoc/docs.go @@ -11433,7 +11433,7 @@ const docTemplate = `{ } }, "codersdk.CreateWorkspaceRequest": { - "description": "CreateWorkspaceRequest provides options for creating a new workspace. Only one of TemplateID or TemplateVersionID can be specified, not both. If TemplateID is specified, the active version of the template will be used.", + "description": "CreateWorkspaceRequest provides options for creating a new workspace. Only one of TemplateID or TemplateVersionID can be specified, not both. If TemplateID is specified, the active version of the template will be used. Workspace names: - Must start with a letter or number - Can only contain letters, numbers, and hyphens - Cannot contain spaces or special characters - Cannot be named ` + "`" + `new` + "`" + ` or ` + "`" + `create` + "`" + ` - Must be unique within your workspaces - Maximum length of 32 characters", "type": "object", "required": [ "name" diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json index 1cea2c58f7255..0464733070ef3 100644 --- a/coderd/apidoc/swagger.json +++ b/coderd/apidoc/swagger.json @@ -10193,7 +10193,7 @@ } }, "codersdk.CreateWorkspaceRequest": { - "description": "CreateWorkspaceRequest provides options for creating a new workspace. Only one of TemplateID or TemplateVersionID can be specified, not both. If TemplateID is specified, the active version of the template will be used.", + "description": "CreateWorkspaceRequest provides options for creating a new workspace. Only one of TemplateID or TemplateVersionID can be specified, not both. If TemplateID is specified, the active version of the template will be used. Workspace names: - Must start with a letter or number - Can only contain letters, numbers, and hyphens - Cannot contain spaces or special characters - Cannot be named `new` or `create` - Must be unique within your workspaces - Maximum length of 32 characters", "type": "object", "required": ["name"], "properties": { diff --git a/codersdk/organizations.go b/codersdk/organizations.go index b981e3bed28fa..b880f25e15a2c 100644 --- a/codersdk/organizations.go +++ b/codersdk/organizations.go @@ -207,6 +207,13 @@ type CreateTemplateRequest struct { // @Description CreateWorkspaceRequest provides options for creating a new workspace. // @Description Only one of TemplateID or TemplateVersionID can be specified, not both. // @Description If TemplateID is specified, the active version of the template will be used. +// @Description Workspace names: +// @Description - Must start with a letter or number +// @Description - Can only contain letters, numbers, and hyphens +// @Description - Cannot contain spaces or special characters +// @Description - Cannot be named `new` or `create` +// @Description - Must be unique within your workspaces +// @Description - Maximum length of 32 characters type CreateWorkspaceRequest struct { // TemplateID specifies which template should be used for creating the workspace. TemplateID uuid.UUID `json:"template_id,omitempty" validate:"required_without=TemplateVersionID,excluded_with=TemplateVersionID" format:"uuid"` diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md index 85b6e65a545aa..79d7a411bf98c 100644 --- a/docs/reference/api/schemas.md +++ b/docs/reference/api/schemas.md @@ -1476,7 +1476,7 @@ None } ``` -CreateWorkspaceRequest provides options for creating a new workspace. Only one of TemplateID or TemplateVersionID can be specified, not both. If TemplateID is specified, the active version of the template will be used. +CreateWorkspaceRequest provides options for creating a new workspace. Only one of TemplateID or TemplateVersionID can be specified, not both. If TemplateID is specified, the active version of the template will be used. Workspace names: - Must start with a letter or number - Can only contain letters, numbers, and hyphens - Cannot contain spaces or special characters - Cannot be named `new` or `create` - Must be unique within your workspaces - Maximum length of 32 characters ### Properties diff --git a/docs/user-guides/workspace-management.md b/docs/user-guides/workspace-management.md index 695b5de36fb79..ad9bd3466b99a 100644 --- a/docs/user-guides/workspace-management.md +++ b/docs/user-guides/workspace-management.md @@ -34,6 +34,17 @@ coder create --template="" coder show ``` +### Workspace name rules and restrictions + +| Constraint | Rule | +|------------------|--------------------------------------------| +| Start/end with | Must start and end with a letter or number | +| Character types | Letters, numbers, and hyphens only | +| Length | 1-32 characters | +| Case sensitivity | Case-insensitive (lowercase recommended) | +| Reserved names | Cannot use `new` or `create` | +| Uniqueness | Must be unique within your workspaces | + ## Workspace filtering In the Coder UI, you can filter your workspaces using pre-defined filters or