Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit0cd531d

Browse files
authored
docs: document workspace naming rules and restrictions (#17312)
closes#12047 [preview](https://coder.com/docs/@12047-workspace-names/user-guides/workspace-management)---------Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parentb0fe626 commit0cd531d

File tree

5 files changed

+21
-3
lines changed

5 files changed

+21
-3
lines changed

‎coderd/apidoc/docs.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎codersdk/organizations.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,13 @@ type CreateTemplateRequest struct {
207207
// @Description CreateWorkspaceRequest provides options for creating a new workspace.
208208
// @Description Only one of TemplateID or TemplateVersionID can be specified, not both.
209209
// @Description If TemplateID is specified, the active version of the template will be used.
210+
// @Description Workspace names:
211+
// @Description - Must start with a letter or number
212+
// @Description - Can only contain letters, numbers, and hyphens
213+
// @Description - Cannot contain spaces or special characters
214+
// @Description - Cannot be named `new` or `create`
215+
// @Description - Must be unique within your workspaces
216+
// @Description - Maximum length of 32 characters
210217
typeCreateWorkspaceRequeststruct {
211218
// TemplateID specifies which template should be used for creating the workspace.
212219
TemplateID uuid.UUID`json:"template_id,omitempty" validate:"required_without=TemplateVersionID,excluded_with=TemplateVersionID" format:"uuid"`

‎docs/reference/api/schemas.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎docs/user-guides/workspace-management.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@ coder create --template="<templateName>" <workspaceName>
3434
coder show<workspace-name>
3535
```
3636

37+
###Workspace name rules and restrictions
38+
39+
| Constraint| Rule|
40+
|------------------|--------------------------------------------|
41+
| Start/end with| Must start and end with a letter or number|
42+
| Character types| Letters, numbers, and hyphens only|
43+
| Length| 1-32 characters|
44+
| Case sensitivity| Case-insensitive (lowercase recommended)|
45+
| Reserved names| Cannot use`new` or`create`|
46+
| Uniqueness| Must be unique within your workspaces|
47+
3748
##Workspace filtering
3849

3950
In the Coder UI, you can filter your workspaces using pre-defined filters or

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp