Skip to content

[Workspace] Allow custom ID to be specified on workspace creation - #11631

Open
nicklas-dohrn wants to merge 3 commits into
opensearch-project:mainfrom
nicklas-dohrn:feature/workspace-custom-id
Open

[Workspace] Allow custom ID to be specified on workspace creation#11631
nicklas-dohrn wants to merge 3 commits into
opensearch-project:mainfrom
nicklas-dohrn:feature/workspace-custom-id

Conversation

@nicklas-dohrn

@nicklas-dohrn nicklas-dohrn commented Mar 31, 2026 •
edited
Loading

Copy link
Copy Markdown

Description

Adds an optional id field to the workspace creation flow — both via the API and the creation UI.

  • API: POST /api/workspaces now accepts attributes.id. When provided, it is used as the workspace ID instead of the auto-generated 6-char base64url value. Must be a UUID or 6–20 alphanumeric/_/- characters. Returns an error if the ID is already taken.
  • UI: A new optional "Workspace ID" field is shown on the creator form with a tooltip explaining the allowed formats. Validation mirrors the server-side rules.

Screenshot of the UI

Screenshot 2026-06-29 at 17 37 01

Related documentation:

Testing the changes

  • Creates workspace with valid custom ID via UI and API
  • Creates workspace without custom ID (falls back to auto-generated)
  • Returns error when workspace with provided ID already exists
  • Returns 400 for invalid ID (too short, too long, invalid chars)

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Commits are signed per the DCO using --signoff

Hailong-am
Hailong-am reviewed Jun 15, 2026
View reviewed changes
Comment thread changelogs/fragments/11631.yml Outdated
@nicklas-dohrn
nicklas-dohrn force-pushed the feature/workspace-custom-id branch from c5ddfd2 to dd0970c Compare June 29, 2026 15:17
nicklas-dohrn added a commit to nicklas-dohrn/OpenSearch-Dashboards that referenced this pull request Jun 29, 2026
@nicklas-dohrn
[Workspace] Allow custom ID to be specified on workspace creation
c11f7f3 
- Allows callers to pass an `id` field in workspace creation attributes
- Validates the custom ID: must be a UUID or 6–20 alphanumeric/hyphen/underscore characters
- Returns HTTP 400 with a descriptive error when the format is invalid
- Checks for duplicate ID and returns HTTP 400 if a workspace with that ID already exists
- Adds changelog fragment for PR opensearch-project#11631

Signed-off-by: nicklas dohrn <nicklas.dohrn@sap.com>
Signed-off-by: Dohrn <nicklas.dohrn@sap.com>
@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit dd0970c

@nicklas-dohrn
nicklas-dohrn marked this pull request as ready for review June 29, 2026 15:25
nicklas-dohrn added a commit to nicklas-dohrn/OpenSearch-Dashboards that referenced this pull request Jun 29, 2026
@nicklas-dohrn
[Workspace] Allow custom ID to be specified on workspace creation
c95bcf5 
- Allows callers to pass an `id` field in workspace creation attributes
- Validates the custom ID: must be a UUID or 6–20 alphanumeric/hyphen/underscore characters
- Returns HTTP 400 with a descriptive error when the format is invalid
- Checks for duplicate ID and returns HTTP 400 if a workspace with that ID already exists
- Adds changelog fragment for PR opensearch-project#11631

Signed-off-by: nicklas dohrn <nicklas.dohrn@sap.com>
Signed-off-by: Dohrn <nicklas.dohrn@sap.com>
Signed-off-by: nicklas-dohrn <nicklas.dohrn@sap.com>
@nicklas-dohrn
nicklas-dohrn force-pushed the feature/workspace-custom-id branch from dd0970c to 0bfff47 Compare June 29, 2026 15:33
nicklas-dohrn added a commit to nicklas-dohrn/OpenSearch-Dashboards that referenced this pull request Jun 29, 2026
@nicklas-dohrn
[Workspace] Allow custom ID to be specified on workspace creation
2389f49 
- Allows callers to pass an `id` field in workspace creation attributes
- Validates the custom ID: must be a UUID or 6–20 alphanumeric/hyphen/underscore characters
- Returns HTTP 400 with a descriptive error when the format is invalid
- Checks for duplicate ID and returns HTTP 400 if a workspace with that ID already exists
- Adds changelog fragment for PR opensearch-project#11631

Signed-off-by: nicklas-dohrn <nicklas.dohrn@sap.com>
@nicklas-dohrn
nicklas-dohrn force-pushed the feature/workspace-custom-id branch from 0bfff47 to ab7fe77 Compare June 29, 2026 15:34
@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit ab7fe77

@nicklas-dohrn
nicklas-dohrn force-pushed the feature/workspace-custom-id branch from ab7fe77 to 88fe22d Compare June 29, 2026 15:36
@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit ab7fe77

@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 88fe22d

@nicklas-dohrn
nicklas-dohrn force-pushed the feature/workspace-custom-id branch from 88fe22d to 653e89d Compare June 29, 2026 15:39
@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 653e89d

@nicklas-dohrn nicklas-dohrn mentioned this pull request Jun 29, 2026
Draft
1 task
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit d16f160

@nicklas-dohrn
nicklas-dohrn force-pushed the feature/workspace-custom-id branch from d16f160 to 1ec36a7 Compare July 13, 2026 08:41
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 1ec36a7

@nicklas-dohrn

nicklas-dohrn commented Jul 13, 2026

Copy link
Copy Markdown
Author

@SuZhou-Joe and @Hailong-am,
I would really appreciate another look here, Added both docs and UI changes if wanted,
all is tested and working.
If we only want to have the api change, that would be fine for me, just thought this would be nice as full integration.

@nicklas-dohrn
[Workspace] Allow custom ID to be specified on workspace creation
9a54f54 
- Allows callers to pass an `id` field in workspace creation attributes
- Validates the custom ID: must be a UUID or 6–20 alphanumeric/hyphen/underscore characters
- Returns HTTP 400 with a descriptive error when the format is invalid
- Checks for duplicate ID and returns HTTP 400 if a workspace with that ID already exists

Signed-off-by: nicklas-dohrn <nicklas.dohrn@sap.com>
@nicklas-dohrn
[Workspace] Add custom ID field to workspace creation UI
9d8113f 
Exposes the custom workspace ID on the creation form so users
can set it from the UI without needing the API directly.

- Adds a `WorkspaceIdField` component with a tooltip listing
  the accepted formats (UUID or 6–20 alphanumeric/hyphen/underscore)
- Validates the ID client-side against the same rules as the server,
  blocking submission and showing an inline error for invalid values
- Clears the validation error on any keystroke so deleting the value
  re-enables auto-generation without a stale error
- Threads `customId` through `WorkspaceFormSubmitData`,
  `useWorkspaceForm`, and `WorkspaceCreator` to the API call
- Adds `InvalidWorkspaceId` error code and callout entry

Signed-off-by: nicklas-dohrn <nicklas.dohrn@sap.com>
@nicklas-dohrn
[Workspace] Fix tests to respect new id handling
d23bb25 
Signed-off-by: nicklas-dohrn <nicklas.dohrn@sap.com>
@nicklas-dohrn
nicklas-dohrn force-pushed the feature/workspace-custom-id branch from 1ec36a7 to d23bb25 Compare July 13, 2026 14:42
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit d23bb25

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ananzh ananzh Awaiting requested review from ananzh ananzh is a code owner
@kavilla kavilla Awaiting requested review from kavilla kavilla is a code owner
@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner
@ashwin-pc ashwin-pc Awaiting requested review from ashwin-pc ashwin-pc is a code owner
@joshuarrrr joshuarrrr Awaiting requested review from joshuarrrr
@abbyhu2000 abbyhu2000 Awaiting requested review from abbyhu2000 abbyhu2000 is a code owner
@zengyan-amazon zengyan-amazon Awaiting requested review from zengyan-amazon zengyan-amazon is a code owner
@zhongnansu zhongnansu Awaiting requested review from zhongnansu zhongnansu is a code owner
@manasvinibs manasvinibs Awaiting requested review from manasvinibs
@ZilongX ZilongX Awaiting requested review from ZilongX ZilongX is a code owner
@Flyingliuhub Flyingliuhub Awaiting requested review from Flyingliuhub
@curq curq Awaiting requested review from curq
@bandinib-amzn bandinib-amzn Awaiting requested review from bandinib-amzn bandinib-amzn is a code owner
@ruanyl ruanyl Awaiting requested review from ruanyl ruanyl is a code owner
@BionIT BionIT Awaiting requested review from BionIT
@xinruiba xinruiba Awaiting requested review from xinruiba xinruiba is a code owner
@zhyuanqi zhyuanqi Awaiting requested review from zhyuanqi zhyuanqi is a code owner
@mengweieric mengweieric Awaiting requested review from mengweieric mengweieric is a code owner
@LDrago27 LDrago27 Awaiting requested review from LDrago27 LDrago27 is a code owner
@virajsanghvi virajsanghvi Awaiting requested review from virajsanghvi virajsanghvi is a code owner
@sejli sejli Awaiting requested review from sejli sejli is a code owner
@joshuali925 joshuali925 Awaiting requested review from joshuali925 joshuali925 is a code owner
@huyaboo huyaboo Awaiting requested review from huyaboo huyaboo is a code owner
@angle943 angle943 Awaiting requested review from angle943 angle943 is a code owner
@Maosaic Maosaic Awaiting requested review from Maosaic Maosaic is a code owner
@wanglam wanglam Awaiting requested review from wanglam wanglam is a code owner
@d-buckner d-buckner Awaiting requested review from d-buckner d-buckner is a code owner
@raintygao raintygao Awaiting requested review from raintygao
@ps48 ps48 Awaiting requested review from ps48 ps48 is a code owner
@TackAdam TackAdam Awaiting requested review from TackAdam TackAdam is a code owner
@ruchidh ruchidh Awaiting requested review from ruchidh ruchidh is a code owner
@sumukhswamy sumukhswamy Awaiting requested review from sumukhswamy sumukhswamy is a code owner
@paulstn paulstn Awaiting requested review from paulstn paulstn is a code owner
@Qxisylolo Qxisylolo Awaiting requested review from Qxisylolo Qxisylolo is a code owner
@yubonluo yubonluo Awaiting requested review from yubonluo yubonluo is a code owner
@FriedhelmWS FriedhelmWS Awaiting requested review from FriedhelmWS FriedhelmWS is a code owner
@SuZhou-Joe SuZhou-Joe Awaiting requested review from SuZhou-Joe SuZhou-Joe is a code owner
@Hailong-am Hailong-am Awaiting requested review from Hailong-am

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

failed changeset first-time-contributor

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@nicklas-dohrn @KarstenSchnitter @SuZhou-Joe @Hailong-am