Skip to content

Commit 7e60ec3

Browse files
committed
use consistent 'realm-instance format' terminology in docs
1 parent d30485d commit 7e60ec3

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

.changeset/friendly-sandbox-id.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
'@salesforce/b2c-tooling-sdk': minor
44
---
55

6-
Add support for friendly sandbox ID format (realm-instance) in ODS commands. You can now use `zzzv-123` or `zzzv_123` instead of full UUIDs for `ods get`, `ods start`, `ods stop`, `ods restart`, and `ods delete` commands.
6+
Add support for realm-instance format in ODS commands. You can now use `zzzv-123` or `zzzv_123` instead of full UUIDs for `ods get`, `ods start`, `ods stop`, `ods restart`, and `ods delete` commands.

docs/cli/ods.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Commands that operate on a specific sandbox (`get`, `start`, `stop`, `restart`,
1313
| Format | Example | Description |
1414
|--------|---------|-------------|
1515
| UUID | `abc12345-1234-1234-1234-abc123456789` | Full sandbox UUID |
16-
| Friendly ID | `zzzv-123` or `zzzv_123` | Realm-instance format |
16+
| Realm-instance | `zzzv-123` or `zzzv_123` | Realm-instance format |
1717

18-
The friendly ID format uses the 4-character realm code followed by a dash (`-`) or underscore (`_`) and the instance identifier. When using a friendly ID, the CLI automatically looks up the corresponding sandbox UUID.
18+
The realm-instance format uses the 4-character realm code followed by a dash (`-`) or underscore (`_`) and the instance identifier. When using the realm-instance format, the CLI automatically looks up the corresponding sandbox UUID.
1919

2020
```bash
2121
# These are equivalent (assuming zzzv-123 resolves to the UUID)
@@ -201,7 +201,7 @@ b2c ods get <SANDBOXID>
201201
# Get sandbox details using UUID
202202
b2c ods get abc12345-1234-1234-1234-abc123456789
203203

204-
# Get sandbox details using friendly ID
204+
# Get sandbox details using realm-instance format
205205
b2c ods get zzzv-123
206206

207207
# Output as JSON
@@ -272,7 +272,7 @@ b2c ods start <SANDBOXID>
272272
# Start a sandbox using UUID
273273
b2c ods start abc12345-1234-1234-1234-abc123456789
274274

275-
# Start a sandbox using friendly ID
275+
# Start a sandbox using realm-instance format
276276
b2c ods start zzzv-123
277277

278278
# Output as JSON
@@ -303,7 +303,7 @@ b2c ods stop <SANDBOXID>
303303
# Stop a sandbox using UUID
304304
b2c ods stop abc12345-1234-1234-1234-abc123456789
305305

306-
# Stop a sandbox using friendly ID
306+
# Stop a sandbox using realm-instance format
307307
b2c ods stop zzzv-123
308308

309309
# Output as JSON
@@ -334,7 +334,7 @@ b2c ods restart <SANDBOXID>
334334
# Restart a sandbox using UUID
335335
b2c ods restart abc12345-1234-1234-1234-abc123456789
336336

337-
# Restart a sandbox using friendly ID
337+
# Restart a sandbox using realm-instance format
338338
b2c ods restart zzzv-123
339339

340340
# Output as JSON
@@ -371,7 +371,7 @@ b2c ods delete <SANDBOXID>
371371
# Delete a sandbox using UUID (with confirmation prompt)
372372
b2c ods delete abc12345-1234-1234-1234-abc123456789
373373

374-
# Delete a sandbox using friendly ID
374+
# Delete a sandbox using realm-instance format
375375
b2c ods delete zzzv-123
376376

377377
# Delete without confirmation

plugins/b2c-cli/skills/b2c-ods/SKILL.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Use the `b2c` CLI plugin to manage Salesforce B2C Commerce On-demand sandboxes (
1212
Commands that operate on a specific sandbox accept two ID formats:
1313

1414
- **UUID**: The full sandbox UUID (e.g., `abc12345-1234-1234-1234-abc123456789`)
15-
- **Friendly ID**: The realm-instance format (e.g., `zzzv-123` or `zzzv_123`)
15+
- **Realm-instance**: The realm-instance format (e.g., `zzzv-123` or `zzzv_123`)
1616

17-
The friendly ID format uses the 4-character realm code followed by a dash or underscore and the instance number. When using a friendly ID, the CLI will automatically look up the corresponding UUID.
17+
The realm-instance format uses the 4-character realm code followed by a dash or underscore and the instance number. When using a realm-instance format, the CLI will automatically look up the corresponding UUID.
1818

1919
## Examples
2020

@@ -47,15 +47,15 @@ b2c ods create --realm zzpq --log-level trace
4747

4848
### Get/Start/Stop/Restart/Delete Sandbox
4949

50-
Commands that operate on a specific sandbox support both UUID and friendly ID formats:
50+
Commands that operate on a specific sandbox support both UUID and realm-instance formats:
5151

5252
```bash
5353
# Using UUID
5454
b2c ods get abc12345-1234-1234-1234-abc123456789
5555
b2c ods start abc12345-1234-1234-1234-abc123456789
5656
b2c ods stop abc12345-1234-1234-1234-abc123456789
5757

58-
# Using friendly ID (realm-instance)
58+
# Using realm-instance format
5959
b2c ods get zzzv-123
6060
b2c ods start zzzv_123
6161
b2c ods stop zzzv-123

0 commit comments

Comments
 (0)