You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`--name <value>`| Yes | Display name, unique within the workspace; 1 to 64 characters. |
2763
2763
|`--language <value>`| Yes | Dependency ecosystem: `javascript` installs from npm, `python` from PyPI. Accepted values: `javascript`, `python`. |
2764
-
|`--dependencies <value...>`| No | Package specifiers installed into the sandbox, one per entry. An entry starting with `#` is a comment and is skipped. (space-separated, or @path / @- with one value per line, blank lines and # comments ignored; @@value for a literal leading @). |
2764
+
|`--dependencies <value...>`| No | Package specifiers installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored; @@value for a literal leading @). |
2765
2765
|`--cli-tools <value...>`| No | Pinned managed CLI ids installed into the sandbox, at most 10, no duplicates. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
2766
-
|`--system-packages <value...>`| No | Debian packages installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line, blank lines and # comments ignored; @@value for a literal leading @). |
2766
+
|`--system-packages <value...>`| No | Debian packages installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored; @@value for a literal leading @). |
|`--name <value>`| No | New display name, unique within the workspace; 1 to 64 characters. |
2862
2862
|`--language <value>`| No | Replacement dependency ecosystem. The whole spec is revalidated against it, so a Python dependency list does not survive a switch to JavaScript. Accepted values: `javascript`, `python`. |
2863
-
|`--dependencies <value...>`| No | Replacement package list; replaces the whole list. (space-separated, or @path / @- with one value per line, blank lines and # comments ignored; @@value for a literal leading @). |
2863
+
|`--dependencies <value...>`| No | Replacement package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored; @@value for a literal leading @). |
2864
2864
|`--cli-tools <value...>`| No | Replacement managed CLI list; replaces the whole list. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
2865
-
|`--system-packages <value...>`| No | Replacement Debian package list; replaces the whole list. (space-separated, or @path / @- with one value per line, blank lines and # comments ignored; @@value for a literal leading @). |
2865
+
|`--system-packages <value...>`| No | Replacement Debian package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored; @@value for a literal leading @). |
Copy file name to clipboardExpand all lines: apps/docs/content/docs/cli/sandboxes.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,9 +25,9 @@ Create Sandbox (personal API key required)
25
25
| --- | --- | --- |
26
26
|`--name <value>`| Yes | Display name, unique within the workspace; 1 to 64 characters. |
27
27
|`--language <value>`| Yes | Dependency ecosystem: `javascript` installs from npm, `python` from PyPI. Accepted values: `javascript`, `python`. |
28
-
|`--dependencies <value...>`| No | Package specifiers installed into the sandbox, one per entry. An entry starting with `#` is a comment and is skipped. (space-separated, or @path / @- with one value per line, blank lines and # comments ignored; @@value for a literal leading @). |
28
+
|`--dependencies <value...>`| No | Package specifiers installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored; @@value for a literal leading @). |
29
29
|`--cli-tools <value...>`| No | Pinned managed CLI ids installed into the sandbox, at most 10, no duplicates. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
30
-
|`--system-packages <value...>`| No | Debian packages installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line, blank lines and # comments ignored; @@value for a literal leading @). |
30
+
|`--system-packages <value...>`| No | Debian packages installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored; @@value for a literal leading @). |
31
31
32
32
</CommandTable>
33
33
@@ -120,8 +120,8 @@ Update Sandbox (personal API key required)
120
120
| --- | --- | --- |
121
121
|`--name <value>`| No | New display name, unique within the workspace; 1 to 64 characters. |
122
122
|`--language <value>`| No | Replacement dependency ecosystem. The whole spec is revalidated against it, so a Python dependency list does not survive a switch to JavaScript. Accepted values: `javascript`, `python`. |
123
-
|`--dependencies <value...>`| No | Replacement package list; replaces the whole list. (space-separated, or @path / @- with one value per line, blank lines and # comments ignored; @@value for a literal leading @). |
123
+
|`--dependencies <value...>`| No | Replacement package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored; @@value for a literal leading @). |
124
124
|`--cli-tools <value...>`| No | Replacement managed CLI list; replaces the whole list. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
125
-
|`--system-packages <value...>`| No | Replacement Debian package list; replaces the whole list. (space-separated, or @path / @- with one value per line, blank lines and # comments ignored; @@value for a literal leading @). |
125
+
|`--system-packages <value...>`| No | Replacement Debian package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored; @@value for a literal leading @). |
Copy file name to clipboardExpand all lines: apps/docs/openapi-v2-resources.json
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2373,7 +2373,7 @@
2373
2373
"delete": {
2374
2374
"operationId": "deleteSandbox",
2375
2375
"summary": "Delete Sandbox",
2376
-
"description": "Delete a sandbox. Function blocks that still select it fail closed at run time until they are re-pointed. Any prebuilt image is released once nothing else shares it. Requires a workspace admin on a Max or Enterprise plan; a lower plan is refused with `403` and `error.details.code` `WORKSPACE_PLAN_CAPABILITY_REQUIRED`. A workspace API key is rejected with `403`; use a personal API key.",
2376
+
"description": "Delete a sandbox. Function blocks that still select it fail closed at run time until they are re-pointed. Where the deployment prebuilds dependency images, the sandbox's image is released once nothing else shares it; a runtime-install deployment, or a spec with nothing to install, had no image and nothing is released. Requires a workspace admin on a Max or Enterprise plan; a lower plan is refused with `403` and `error.details.code` `WORKSPACE_PLAN_CAPABILITY_REQUIRED`. A workspace API key is rejected with `403`; use a personal API key.",
2377
2377
"tags": ["Sandboxes"],
2378
2378
"parameters": [
2379
2379
{
@@ -4774,7 +4774,7 @@
4774
4774
"example": {
4775
4775
"error": {
4776
4776
"code": "CONFLICT",
4777
-
"message": "A resource with this name already exists in this workspace"
4777
+
"message": "The request conflicts with the current state of the resource"
4778
4778
}
4779
4779
}
4780
4780
}
@@ -6809,7 +6809,7 @@
6809
6809
"items": {
6810
6810
"type": "string"
6811
6811
},
6812
-
"description": "Package specifiers installed into the sandbox, one per entry. An entry starting with `#` is a comment and is skipped."
6812
+
"description": "Package specifiers installed into the sandbox, one per entry."
6813
6813
},
6814
6814
"cliTools": {
6815
6815
"type": "array",
@@ -7044,7 +7044,7 @@
7044
7044
},
7045
7045
"dependencies": {
7046
7046
"default": [],
7047
-
"description": "Package specifiers installed into the sandbox, one per entry. An entry starting with `#` is a comment and is skipped.",
7047
+
"description": "Package specifiers installed into the sandbox, one per entry.",
Copy file name to clipboardExpand all lines: apps/sim/lib/api/contracts/v2/openapi/resources.ts
+5-6Lines changed: 5 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1371,7 +1371,7 @@ const declaredRoutes = [
1371
1371
resourceOperation('Sandboxes',{
1372
1372
operationId: 'deleteSandbox',
1373
1373
summary: 'Delete Sandbox',
1374
-
description: `Delete a sandbox. Function blocks that still select it fail closed at run time until they are re-pointed. Any prebuilt image is released once nothing else shares it. ${SANDBOX_ADMIN_PLAN_NOTE}${WORKSPACE_API_KEY_DENIED}`,
1374
+
description: `Delete a sandbox. Function blocks that still select it fail closed at run time until they are re-pointed. Where the deployment prebuilds dependency images, the sandbox's image is released once nothing else shares it; a runtime-install deployment, or a spec with nothing to install, had no image and nothing is released. ${SANDBOX_ADMIN_PLAN_NOTE}${WORKSPACE_API_KEY_DENIED}`,
1375
1375
errors: RESOURCE_ERRORS,
1376
1376
success: {description: 'The sandbox was deleted.'},
0 commit comments