Skip to content

Commit 0c3c9ac

Browse files
committed
Preserve OpenAPI schema details in reference
1 parent 93b612d commit 0c3c9ac

39 files changed

Lines changed: 815 additions & 37 deletions

‎reference/manifest.json‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,42 @@
44
"connect/process.md": "037574455e9e8c5159c391d8c007e7272560f62c4e5ee681f8aec29f9cd24539",
55
"openapi/control-plane.yml": "99e42c340a18ac1f3bda9321d347b01f6bd8326c39373e92797bfb179ee0a0bf",
66
"openapi/envd.yml": "334700432025fcdfd9f95f9e58d90e6290b835015a24f269548eba5500c0df4f",
7-
"openapi/markdown/assignTemplateTags.md": "3ec3dc705cbda5780d0a9e78234c7777f014784b2ec193821b6f5bb2ea26ec57",
8-
"openapi/markdown/composeFiles.md": "172894794d346ac42d1357e28aafa5c6daea32f361977d0e8d7ac43b04c61577",
9-
"openapi/markdown/connectSandbox.md": "9106d09a6f525aa0bcbd1eed06de62a4d015d1f6fa63496ccb6aebbebb3ad332",
10-
"openapi/markdown/createSandbox.md": "3bf499af52b01f87e48dfa56c0af227d4d22f755444118e8a8422b216c851f8d",
11-
"openapi/markdown/createSnapshot.md": "433724d1260fd60e68268a2984f7ca7ae54a1cad120fb25a026b6a6518af004f",
12-
"openapi/markdown/createTemplate.md": "b31935eef9b0c29bcd9402f7401a4159c349bed8b3e5458c4490870574bc2974",
13-
"openapi/markdown/deleteTemplate.md": "3f9a6ab1e0ab144f0a68e41938ef23fd07ac2509b16f6b4b9df5478e54a5865c",
14-
"openapi/markdown/deleteTemplateTags.md": "1b907ed1b5d9cd55a3b21f46c207217af8a4efe0fe6ccb56a8f988567fc27395",
15-
"openapi/markdown/downloadFile.md": "828154a446933bd19b1f20ca9170f6e93f2f80872fc08e92e46d339872e8f45c",
16-
"openapi/markdown/forkSandbox.md": "84962addf6f2d49e40aaaca2e27f79e8e98991f703c7374e8852d4e47944dbc4",
17-
"openapi/markdown/getEnvironmentHealth.md": "7595329f0fceb5ba613d73f8c522287f7836651d9a2dc44002a149c3ca8c57bf",
18-
"openapi/markdown/getEnvironmentMetrics.md": "d6ebfaa682e3e2b6489703daf643b887362f5fdca055f9f3b2367143b03a5112",
19-
"openapi/markdown/getEnvironmentVariables.md": "58fe720040afa68bc542c0416378bab9642dbfe73d397b923b220e44bb4c2f54",
20-
"openapi/markdown/getSandbox.md": "fb4a7184f903a8bdd8c3b7ea1d00b10d17d26c6dc56b1e7f1a07f91f99aee09d",
21-
"openapi/markdown/getSandboxLogs.md": "a3055767e82145d9c0cb1953ee1081489c0098200018802292634e4cb3c830c2",
22-
"openapi/markdown/getSandboxMetrics.md": "1572d44d0ff539495dadcbb909bb1e640b73375fcb4b0840243e692066162ace",
23-
"openapi/markdown/getTeamMetrics.md": "063860650df86f09f1119f441b1410b1e329dd20000cf1b1f8a1f84fdcbdac53",
24-
"openapi/markdown/getTeamMetricsMax.md": "5e5e6578470d1710c993ae69a91b34badaaa86e62e141eb91e57c6e0f7594fe6",
25-
"openapi/markdown/getTemplate.md": "a4747e42b28bb014ae4eb3b5477fe6d58cfda25c00ae829c339cfb7ef5ec6715",
26-
"openapi/markdown/getTemplateBuildLogs.md": "5f696d204a13be42ce9df32b51ac4680b853231595d84e14aca9db7e05b385ff",
27-
"openapi/markdown/getTemplateBuildStatus.md": "7ef1697ca9b6c3d44624df8ca528fdc5e4f81ebd226c748ae2183b2e99e27757",
28-
"openapi/markdown/getTemplateByAlias.md": "2a42010266038d50581e3526becf1f35ad3ada6eecd757522b083817fe435301",
29-
"openapi/markdown/getTemplateUploadUrl.md": "b06cb4aaed389e75daa8e509e3437a23915aad2b03ef6e69597df67984a48b19",
30-
"openapi/markdown/killSandbox.md": "c864528a36849a512be77bf144ef7d41356f01cb0dbbe1d2f5143712a95268f2",
31-
"openapi/markdown/listSandboxMetrics.md": "38cc35b6d1087635efc6fa351da48402a021f12b185e3bbfbafacc64a34b8d87",
32-
"openapi/markdown/listSandboxes.md": "ebb79c21ab83ad61ea2e7c738fa2f77d37c001e2d09142508209e7beab687aeb",
33-
"openapi/markdown/listSnapshots.md": "d7f7ae67491c5da2930181b0fe423ef8ad661f5f4e7e88f47ecfb58cb08ac83f",
34-
"openapi/markdown/listTemplateTags.md": "df27ed0dc04e6b49a3dc92704842e30365f50e88c8e28e6a5323a16aa10b7c45",
35-
"openapi/markdown/listTemplates.md": "e89b7d18efcfa6e16385e6b4e2f227ad2e5c9fa7608426ece673077a35468e12",
36-
"openapi/markdown/pauseSandbox.md": "0d1e7dd52ca966d37742e7d34898559dfd03c4ba3ca7f83f1859ddaefa9b0464",
37-
"openapi/markdown/refreshSandbox.md": "dea1862241aad45c17b194994722a23941263bb697b885e795ba97cf154469bd",
38-
"openapi/markdown/setSandboxTimeout.md": "ee0aaf78e2c0ffcdf4df1bde703fd4442d5436efad290bc235d1acc120adb997",
39-
"openapi/markdown/startTemplateBuild.md": "f987c7627a0170ff2908fd344d76acea3b2d8f7875686ff746ad8a8b2b3922c4",
40-
"openapi/markdown/updateSandboxNetwork.md": "0254acd4dca8299bd7198024660bb1300752c6842f225c604389dd1951333675",
41-
"openapi/markdown/updateTemplate.md": "ace7930be4091213fc2e29a7109f489eaaf3a0e1d210aa65d9663a5adbf92250",
42-
"openapi/markdown/uploadFile.md": "2c3b042f305f2e7234799f0af14979965e76a10ced1a74a464bb6afd96c5c68c",
7+
"openapi/markdown/assignTemplateTags.md": "d537a5123d8d2f6a6e5bc533db96d530e372b8aa4a6dbad3808904ca59e232fb",
8+
"openapi/markdown/composeFiles.md": "208ca29c5143720389bc82db267aa8aaa2e8e7780e8a6cd5c9e11717bb44c84a",
9+
"openapi/markdown/connectSandbox.md": "a49c231cbfaeba9f6363c3d053e2aacd6fa55b19543251394c88f234a9f992e9",
10+
"openapi/markdown/createSandbox.md": "2c318c95e7c97747d968ce7a764f833f4632e9b0cea00a13bceb3d579356e418",
11+
"openapi/markdown/createSnapshot.md": "1af5dcb96e3217dfc98a54eb43cc721cdd58f875f88bd77cde0b4fe34df0cb0d",
12+
"openapi/markdown/createTemplate.md": "1a8b379df9e0e03c7b1c1fe0308d693dc09e589c3d474ee521d71fe556a96db2",
13+
"openapi/markdown/deleteTemplate.md": "c0dff20f19cb6d8958f8ee859154f9a2508bb0da6c6a4f8bdb517fd275974e83",
14+
"openapi/markdown/deleteTemplateTags.md": "468d6c2299f22c0be084edbc0f248fcf28cdd671a8551a30433ad28081e22f8d",
15+
"openapi/markdown/downloadFile.md": "b116ab967ca2d42bcadf8e2c2db90d90686126b58fe7275efc6e2df09fa45745",
16+
"openapi/markdown/forkSandbox.md": "4af6d08cb5897c424118b043ab0b6bb8e176926cf3a8f2e94ede685915086592",
17+
"openapi/markdown/getEnvironmentHealth.md": "e340276ca13456d2feee70f7d68f2b9b58a8efaac792c0845cf328988674e500",
18+
"openapi/markdown/getEnvironmentMetrics.md": "5a86cbd31c9fcdd2aa468a708527e8935d276ca2af4a33cb7d431f347b972a3a",
19+
"openapi/markdown/getEnvironmentVariables.md": "e9f9dba427ff7cb37aad0a7fd248e57e68d0f09235755689fb4f0f3bd0898171",
20+
"openapi/markdown/getSandbox.md": "b4114feed35bac9cf566e9031e4393b6b74a8b0295cb991334c84e24cb24212b",
21+
"openapi/markdown/getSandboxLogs.md": "92b387304e1635507fb734ea2381442b02692788cc5bcaef029501517459823a",
22+
"openapi/markdown/getSandboxMetrics.md": "7dfe5a9f4349cf4721870190dc4dfb709f1abea827c48c421b252db37842e059",
23+
"openapi/markdown/getTeamMetrics.md": "43c9ea28cf683e7cb90ba3ba73b2295d412ac571ad3969fe207c284eaedb9f5b",
24+
"openapi/markdown/getTeamMetricsMax.md": "f1fb70b4b96926d15b6b2da15a3a3385e3ce6d3625739690e3ac261522b7a66b",
25+
"openapi/markdown/getTemplate.md": "2b9860253eea9a9c70efc7b09afe4bb46a77b47d615e37ebe816fb30443277b3",
26+
"openapi/markdown/getTemplateBuildLogs.md": "9ac9b52688a7c2b18e2cb1463ffaace332f3912675a7418e948aa03114ef1282",
27+
"openapi/markdown/getTemplateBuildStatus.md": "7c49468fd4dc545151785d74b7bf3d7a4f81cd3652f2a94ea4bdca34d2f1a030",
28+
"openapi/markdown/getTemplateByAlias.md": "2a45d21244f6416182a4b4c44df7e912c63531bf191a52f92ca72579ef889bca",
29+
"openapi/markdown/getTemplateUploadUrl.md": "2913bbd4444042dae3e0fc3bdb8b93619499885c9037021b1d025d149d0eaa14",
30+
"openapi/markdown/killSandbox.md": "8d552c09878a176f3337456fa1506c8c8ce494e49cd66fc550210ed4d56b3876",
31+
"openapi/markdown/listSandboxMetrics.md": "12aa00b1ab43fd7d3ed305484d1cf0e8abe2b76fe8198eb43082b1c9b56bf95c",
32+
"openapi/markdown/listSandboxes.md": "f6d2112f7e80864cbca32b55e10ad64ac4744854e6e55fa7df88820e6e89958d",
33+
"openapi/markdown/listSnapshots.md": "a0b9150b60a0d392bf928c72202d5c1283a0d7f110b8a569771b89807129c894",
34+
"openapi/markdown/listTemplateTags.md": "2fe73787ba32d2049a425377462dacbca9b80b36ec6551815eec3e987d135413",
35+
"openapi/markdown/listTemplates.md": "0b3f649933c0f2fdfd3f1edec3dc3995053edc3e4f9babb902bd9c591b1b640a",
36+
"openapi/markdown/pauseSandbox.md": "d33a86ed2c8c48c9a1c81ac5e80dfa244fb92b1ff8ef2cdddfefc2f8270949d7",
37+
"openapi/markdown/refreshSandbox.md": "9f8580277cd6ffd79c2313f8688ed796916c2d457a19355094efcce72fa4207d",
38+
"openapi/markdown/setSandboxTimeout.md": "3474378751522f5ad93035aafcc0b74221ebdd3e76c04a7c0a2d9c8f241fa228",
39+
"openapi/markdown/startTemplateBuild.md": "bd1d7c7347453247d6a14e871c5697333fc47b8369d7c9edace518083cb41917",
40+
"openapi/markdown/updateSandboxNetwork.md": "20e9cd1722fbf1e0af5f1a925ef8e64b27ce98a26afba6fc1d6cdafd96f0e444",
41+
"openapi/markdown/updateTemplate.md": "f067cc266d8eddeab02fb70f548703ec44f187ca9c3b79c9a908d71a14e067f9",
42+
"openapi/markdown/uploadFile.md": "3a3b5ebadf3282a18f90d58a220152aea0eba9eb5ad455ac89483a0acc44e8c7",
4343
"openapi/operations.json": "f5097d93fb7eb5f6482e632624d5a212e29441ef8c558601ccbe2dae26db050d",
4444
"sdk/cli/auth.md": "0b2c75262b0c0670c7bc0f0f3cbed65fbe4a16d6fe4437789a5685b8bf2174a1",
4545
"sdk/cli/sandbox.md": "16b64c5a4e932eca2452e400e0faf154eba1d3c7373513aa7cd9744e02908313",

‎reference/openapi/markdown/assignTemplateTags.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Schema: `AssignedTemplateTags`
3838

3939
Identifier of the build associated with these tags
4040

41+
Format: `uuid`
42+
4143
### 400
4244

4345
Bad request
@@ -50,6 +52,8 @@ Schema: `Error`
5052

5153
Error code
5254

55+
Format: `int32`
56+
5357
- **`message`** · `string` · required
5458

5559
Error
@@ -66,6 +70,8 @@ Schema: `Error`
6670

6771
Error code
6872

73+
Format: `int32`
74+
6975
- **`message`** · `string` · required
7076

7177
Error
@@ -82,6 +88,8 @@ Schema: `Error`
8288

8389
Error code
8490

91+
Format: `int32`
92+
8593
- **`message`** · `string` · required
8694

8795
Error
@@ -98,6 +106,8 @@ Schema: `Error`
98106

99107
Error code
100108

109+
Format: `int32`
110+
101111
- **`message`** · `string` · required
102112

103113
Error

‎reference/openapi/markdown/composeFiles.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Compose multiple files into a single file using zero-copy concatenation. Source
1212

1313
Internal envd HTTP port exposed through the sandbox proxy.
1414

15+
Default: `49983`
16+
1517
## Request body
1618

1719
Required: yes
@@ -54,6 +56,8 @@ Schema: `EntryInfo`
5456

5557
Type of the file
5658

59+
Allowed values: `file`
60+
5761
- **`metadata`** · `object` · optional
5862

5963
User-defined metadata stored as extended attributes on the file.

‎reference/openapi/markdown/connectSandbox.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Schema: `ConnectSandbox`
2020

2121
Timeout in seconds from the current time after which the sandbox should expire
2222

23+
Format: `int32`
24+
25+
Minimum: `0`
26+
2327
## Responses
2428

2529
### 200
@@ -90,6 +94,8 @@ Schema: `Error`
9094

9195
Error code
9296

97+
Format: `int32`
98+
9399
- **`message`** · `string` · required
94100

95101
Error
@@ -106,6 +112,8 @@ Schema: `Error`
106112

107113
Error code
108114

115+
Format: `int32`
116+
109117
- **`message`** · `string` · required
110118

111119
Error
@@ -122,6 +130,8 @@ Schema: `Error`
122130

123131
Error code
124132

133+
Format: `int32`
134+
125135
- **`message`** · `string` · required
126136

127137
Error
@@ -138,6 +148,8 @@ Schema: `Error`
138148

139149
Error code
140150

151+
Format: `int32`
152+
141153
- **`message`** · `string` · required
142154

143155
Error

‎reference/openapi/markdown/createSandbox.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,24 @@ Schema: `NewSandbox`
2020

2121
Time to live for the sandbox in seconds.
2222

23+
Format: `int32`
24+
25+
Default: `15`
26+
27+
Minimum: `0`
28+
2329
- **`autoPause`** · `boolean` · optional
2430

2531
Automatically pauses the sandbox after the timeout
2632

33+
Default: `false`
34+
2735
- **`autoPauseMemory`** · `boolean` · optional
2836

2937
Controls the snapshot kind taken when the sandbox auto-pauses on timeout (only relevant when autoPause is true). When false, the auto-pause drops the in-memory state and persists only the filesystem (a filesystem-only snapshot); resuming it cold-boots (reboots) the sandbox from disk. Such a snapshot cannot be auto-resumed by traffic and must be resumed explicitly, so it cannot be combined with autoResume. Defaults to true (full memory snapshot).
3038

39+
Default: `true`
40+
3141
- **`autoResume`** · `SandboxAutoResumeConfig` · optional
3242

3343
Auto-resume configuration for paused sandboxes.
@@ -36,6 +46,8 @@ Schema: `NewSandbox`
3646

3747
Auto-resume enabled flag for paused sandboxes. Default false.
3848

49+
Default: `false`
50+
3951
- **`secure`** · `boolean` · optional
4052

4153
Secure all system communication with sandbox
@@ -50,6 +62,8 @@ Schema: `NewSandbox`
5062

5163
Specify if the sandbox URLs should be accessible only with authentication.
5264

65+
Default: `true`
66+
5367
- **`network.allowOut`** · `array<string>` · optional
5468

5569
List of allowed destinations for egress traffic. Each entry can be a CIDR block (e.g. "8.8.8.8/32"), a bare IP address (e.g. "8.8.8.8"), or a domain name (e.g. "example.com", "*.example.com"). Allowed entries always take precedence over denied entries.
@@ -156,6 +170,8 @@ Schema: `Error`
156170

157171
Error code
158172

173+
Format: `int32`
174+
159175
- **`message`** · `string` · required
160176

161177
Error
@@ -172,6 +188,8 @@ Schema: `Error`
172188

173189
Error code
174190

191+
Format: `int32`
192+
175193
- **`message`** · `string` · required
176194

177195
Error
@@ -188,6 +206,8 @@ Schema: `Error`
188206

189207
Error code
190208

209+
Format: `int32`
210+
191211
- **`message`** · `string` · required
192212

193213
Error

‎reference/openapi/markdown/createSnapshot.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Schema: `Error`
5050

5151
Error code
5252

53+
Format: `int32`
54+
5355
- **`message`** · `string` · required
5456

5557
Error
@@ -66,6 +68,8 @@ Schema: `Error`
6668

6769
Error code
6870

71+
Format: `int32`
72+
6973
- **`message`** · `string` · required
7074

7175
Error
@@ -82,6 +86,8 @@ Schema: `Error`
8286

8387
Error code
8488

89+
Format: `int32`
90+
8591
- **`message`** · `string` · required
8692

8793
Error
@@ -98,6 +104,8 @@ Schema: `Error`
98104

99105
Error code
100106

107+
Format: `int32`
108+
101109
- **`message`** · `string` · required
102110

103111
Error

‎reference/openapi/markdown/createTemplate.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Schema: `TemplateBuildRequestV3`
1616

1717
Name of the template. Can include a tag with colon separator (e.g. "my-template" or "my-template:v1"). If tag is included, it will be treated as if the tag was provided in the tags array.
1818

19+
Maximum length: `128`
20+
1921
- **`tags`** · `array<string>` · optional
2022

2123
Tags to assign to the template build
@@ -24,10 +26,18 @@ Schema: `TemplateBuildRequestV3`
2426

2527
CPU cores for the sandbox
2628

29+
Format: `int32`
30+
31+
Minimum: `1`
32+
2733
- **`memoryMB`** · `MemoryMB` · optional
2834

2935
Memory for the sandbox in MiB
3036

37+
Format: `int32`
38+
39+
Minimum: `128`
40+
3141
## Responses
3242

3343
### 202
@@ -70,6 +80,8 @@ Schema: `Error`
7080

7181
Error code
7282

83+
Format: `int32`
84+
7385
- **`message`** · `string` · required
7486

7587
Error
@@ -86,6 +98,8 @@ Schema: `Error`
8698

8799
Error code
88100

101+
Format: `int32`
102+
89103
- **`message`** · `string` · required
90104

91105
Error
@@ -102,6 +116,8 @@ Schema: `Error`
102116

103117
Error code
104118

119+
Format: `int32`
120+
105121
- **`message`** · `string` · required
106122

107123
Error
@@ -118,6 +134,8 @@ Schema: `Error`
118134

119135
Error code
120136

137+
Format: `int32`
138+
121139
- **`message`** · `string` · required
122140

123141
Error

‎reference/openapi/markdown/deleteTemplate.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Schema: `Error`
2626

2727
Error code
2828

29+
Format: `int32`
30+
2931
- **`message`** · `string` · required
3032

3133
Error
@@ -42,6 +44,8 @@ Schema: `Error`
4244

4345
Error code
4446

47+
Format: `int32`
48+
4549
- **`message`** · `string` · required
4650

4751
Error

0 commit comments

Comments
 (0)