diff --git a/reference-config/operations.yaml b/reference-config/operations.yaml index bd00e7ef..2410fc6d 100644 --- a/reference-config/operations.yaml +++ b/reference-config/operations.yaml @@ -10,45 +10,45 @@ controlPlane: - templates - tags operations: - GET /teams/{teamID}/metrics: { id: getTeamMetrics, group: team-metrics, slug: team-metrics } - GET /teams/{teamID}/metrics/max: { id: getTeamMetricsMax, group: team-metrics, slug: team-metrics-max } - POST /sandboxes: { id: createSandbox, group: sandboxes, slug: create } - GET /v2/sandboxes: { id: listSandboxes, group: sandboxes, slug: list } - GET /sandboxes/metrics: { id: listSandboxMetrics, group: sandboxes, slug: list-metrics } - GET /v2/sandboxes/{sandboxID}/logs: { id: getSandboxLogs, group: sandboxes, slug: logs } - GET /sandboxes/{sandboxID}: { id: getSandbox, group: sandboxes, slug: get } - DELETE /sandboxes/{sandboxID}: { id: killSandbox, group: sandboxes, slug: kill } - GET /sandboxes/{sandboxID}/metrics: { id: getSandboxMetrics, group: sandboxes, slug: metrics } - POST /sandboxes/{sandboxID}/pause: { id: pauseSandbox, group: sandboxes, slug: pause } - POST /sandboxes/{sandboxID}/fork: { id: forkSandbox, group: sandboxes, slug: fork } - POST /sandboxes/{sandboxID}/connect: { id: connectSandbox, group: sandboxes, slug: connect } - POST /sandboxes/{sandboxID}/timeout: { id: setSandboxTimeout, group: sandboxes, slug: timeout } - PUT /sandboxes/{sandboxID}/network: { id: updateSandboxNetwork, group: sandboxes, slug: network } - POST /sandboxes/{sandboxID}/refreshes: { id: refreshSandbox, group: sandboxes, slug: refresh } - POST /sandboxes/{sandboxID}/snapshots: { id: createSnapshot, group: snapshots, slug: create } - GET /snapshots: { id: listSnapshots, group: snapshots, slug: list } - POST /v3/templates: { id: createTemplate, group: templates, slug: create } - GET /v2/templates: { id: listTemplates, group: templates, slug: list } - GET /templates/{templateID}/files/{hash}: { id: getTemplateUploadUrl, group: templates, slug: upload-url } - GET /templates/{templateID}: { id: getTemplate, group: templates, slug: get } - DELETE /templates/{templateID}: { id: deleteTemplate, group: templates, slug: delete } - POST /v2/templates/{templateID}/builds/{buildID}: { id: startTemplateBuild, group: templates, slug: start-build } - PATCH /v2/templates/{templateID}: { id: updateTemplate, group: templates, slug: update } - GET /templates/{templateID}/builds/{buildID}/status: { id: getTemplateBuildStatus, group: templates, slug: build-status } - GET /templates/{templateID}/builds/{buildID}/logs: { id: getTemplateBuildLogs, group: templates, slug: build-logs } - POST /templates/tags: { id: assignTemplateTags, group: tags, slug: assign } - DELETE /templates/tags: { id: deleteTemplateTags, group: tags, slug: delete } - GET /templates/{templateID}/tags: { id: listTemplateTags, group: tags, slug: list } - GET /templates/aliases/{alias}: { id: getTemplateByAlias, group: templates, slug: alias } + GET /teams/{teamID}/metrics: { id: getTeamMetrics, group: team-metrics, slug: team-metrics, summary: Get team metrics } + GET /teams/{teamID}/metrics/max: { id: getTeamMetricsMax, group: team-metrics, slug: team-metrics-max, summary: Get maximum team metrics } + POST /sandboxes: { id: createSandbox, group: sandboxes, slug: create, summary: Create sandbox } + GET /v2/sandboxes: { id: listSandboxes, group: sandboxes, slug: list, summary: List sandboxes } + GET /sandboxes/metrics: { id: listSandboxMetrics, group: sandboxes, slug: list-metrics, summary: List sandbox metrics } + GET /v2/sandboxes/{sandboxID}/logs: { id: getSandboxLogs, group: sandboxes, slug: logs, summary: Get sandbox logs } + GET /sandboxes/{sandboxID}: { id: getSandbox, group: sandboxes, slug: get, summary: Get sandbox } + DELETE /sandboxes/{sandboxID}: { id: killSandbox, group: sandboxes, slug: kill, summary: Kill sandbox } + GET /sandboxes/{sandboxID}/metrics: { id: getSandboxMetrics, group: sandboxes, slug: metrics, summary: Get sandbox metrics } + POST /sandboxes/{sandboxID}/pause: { id: pauseSandbox, group: sandboxes, slug: pause, summary: Pause sandbox } + POST /sandboxes/{sandboxID}/fork: { id: forkSandbox, group: sandboxes, slug: fork, summary: Fork sandbox } + POST /sandboxes/{sandboxID}/connect: { id: connectSandbox, group: sandboxes, slug: connect, summary: Connect sandbox } + POST /sandboxes/{sandboxID}/timeout: { id: setSandboxTimeout, group: sandboxes, slug: timeout, summary: Set sandbox timeout } + PUT /sandboxes/{sandboxID}/network: { id: updateSandboxNetwork, group: sandboxes, slug: network, summary: Update sandbox network } + POST /sandboxes/{sandboxID}/refreshes: { id: refreshSandbox, group: sandboxes, slug: refresh, summary: Refresh sandbox } + POST /sandboxes/{sandboxID}/snapshots: { id: createSnapshot, group: snapshots, slug: create, summary: Create snapshot } + GET /snapshots: { id: listSnapshots, group: snapshots, slug: list, summary: List snapshots } + POST /v3/templates: { id: createTemplate, group: templates, slug: create, summary: Create template } + GET /v2/templates: { id: listTemplates, group: templates, slug: list, summary: List templates } + GET /templates/{templateID}/files/{hash}: { id: getTemplateUploadUrl, group: templates, slug: upload-url, summary: Get template upload URL } + GET /templates/{templateID}: { id: getTemplate, group: templates, slug: get, summary: Get template } + DELETE /templates/{templateID}: { id: deleteTemplate, group: templates, slug: delete, summary: Delete template } + POST /v2/templates/{templateID}/builds/{buildID}: { id: startTemplateBuild, group: templates, slug: start-build, summary: Start template build } + PATCH /v2/templates/{templateID}: { id: updateTemplate, group: templates, slug: update, summary: Update template } + GET /templates/{templateID}/builds/{buildID}/status: { id: getTemplateBuildStatus, group: templates, slug: build-status, summary: Get template build status } + GET /templates/{templateID}/builds/{buildID}/logs: { id: getTemplateBuildLogs, group: templates, slug: build-logs, summary: Get template build logs } + POST /templates/tags: { id: assignTemplateTags, group: tags, slug: assign, summary: Assign template tags } + DELETE /templates/tags: { id: deleteTemplateTags, group: tags, slug: delete, summary: Delete template tags } + GET /templates/{templateID}/tags: { id: listTemplateTags, group: tags, slug: list, summary: List template tags } + GET /templates/aliases/{alias}: { id: getTemplateByAlias, group: templates, slug: alias, summary: Get template by alias } envd: source: spec/envd/envd.yaml publicAuthSchemes: - AccessTokenAuth operations: - GET /health: { id: getEnvironmentHealth, group: environment, slug: health } - GET /metrics: { id: getEnvironmentMetrics, group: environment, slug: metrics } - GET /envs: { id: getEnvironmentVariables, group: environment, slug: variables } - GET /files: { id: downloadFile, group: files, slug: download } - POST /files: { id: uploadFile, group: files, slug: upload } - POST /files/compose: { id: composeFiles, group: files, slug: compose } + GET /health: { id: getEnvironmentHealth, group: environment, slug: health, summary: Check environment health } + GET /metrics: { id: getEnvironmentMetrics, group: environment, slug: metrics, summary: Get environment metrics } + GET /envs: { id: getEnvironmentVariables, group: environment, slug: variables, summary: Get environment variables } + GET /files: { id: downloadFile, group: files, slug: download, summary: Download file } + POST /files: { id: uploadFile, group: files, slug: upload, summary: Upload file } + POST /files/compose: { id: composeFiles, group: files, slug: compose, summary: Compose files } diff --git a/reference/manifest.json b/reference/manifest.json index 798c3f9d..f718a483 100644 --- a/reference/manifest.json +++ b/reference/manifest.json @@ -4,43 +4,43 @@ "connect/process.md": "037574455e9e8c5159c391d8c007e7272560f62c4e5ee681f8aec29f9cd24539", "openapi/control-plane.yml": "95df3951c30223827e4933f1dab8c6e2c75a2a8d81269646f807427d11078548", "openapi/envd.yml": "30a0fba3b410c77db6b50b674f0ef9d110bf626ca2558820b5a6a05e4640cf19", - "openapi/markdown/assignTemplateTags.md": "fa9f7b2fd59332151695fab853f7f29b253e8837bbd6d8fa669258a303622819", - "openapi/markdown/composeFiles.md": "c814b69b4721e1a8c1a4d202bfc38feccfd12576071a21af8d9380baf6c2ff28", - "openapi/markdown/connectSandbox.md": "035437cfff8d3174ac6517b90c3da75dc338181ec19d07274cef46430453c6ed", - "openapi/markdown/createSandbox.md": "d9934ce3b88e1aa9df092fbff4ad88b87136b6ed786c3c7ca1aba86b361ac51a", - "openapi/markdown/createSnapshot.md": "b1aaf62afe3723c04fcd7c1f1b092a24a0342b28de2b680d6a9d0afc014ddc3b", - "openapi/markdown/createTemplate.md": "6e9fe66bc4a9671fd778620064989117fd40a560d5a0e2db874e6ade707384c4", - "openapi/markdown/deleteTemplate.md": "31f4140050bb8753a0e8294f4b60425695866b2a3930a861ed1657ec4fb07029", - "openapi/markdown/deleteTemplateTags.md": "94e5f1831a4044ea6acb248326fba83d9c6f0123bd61a3b2c401426fcd434b82", - "openapi/markdown/downloadFile.md": "3cded9f4d62b95e4fbb6bc4d548340c5943538010b04bfba690bfb042cd0ae4d", - "openapi/markdown/forkSandbox.md": "e773314d8f074b168db204072097c2bff06fac52960d5a89db5172a980ab8668", + "openapi/markdown/assignTemplateTags.md": "3ec3dc705cbda5780d0a9e78234c7777f014784b2ec193821b6f5bb2ea26ec57", + "openapi/markdown/composeFiles.md": "3e5c37b40268689b6e5287a906c75b80f71fefafe94205c6327c976ca0594d5c", + "openapi/markdown/connectSandbox.md": "9106d09a6f525aa0bcbd1eed06de62a4d015d1f6fa63496ccb6aebbebb3ad332", + "openapi/markdown/createSandbox.md": "42b8b28e9aac9bcbbacec9dec346d043340f8c94ac497147a80910341572226f", + "openapi/markdown/createSnapshot.md": "433724d1260fd60e68268a2984f7ca7ae54a1cad120fb25a026b6a6518af004f", + "openapi/markdown/createTemplate.md": "b31935eef9b0c29bcd9402f7401a4159c349bed8b3e5458c4490870574bc2974", + "openapi/markdown/deleteTemplate.md": "3f9a6ab1e0ab144f0a68e41938ef23fd07ac2509b16f6b4b9df5478e54a5865c", + "openapi/markdown/deleteTemplateTags.md": "1b907ed1b5d9cd55a3b21f46c207217af8a4efe0fe6ccb56a8f988567fc27395", + "openapi/markdown/downloadFile.md": "d687f0fadf42a0c8d40324fbf6a732677dae38ed1cf02a755cf86eb9a5155abc", + "openapi/markdown/forkSandbox.md": "bc7846648216b1104ed1d1661eb08b9881b3fef7616bfae49542eca1d228e76e", "openapi/markdown/getEnvironmentHealth.md": "640c9435ce216a6fd0e5da7ee646d8527e5de428c946fad219946f5c1de5622a", - "openapi/markdown/getEnvironmentMetrics.md": "32f7d61ddb8980caec0beaa3821b99e5f6ef90c0e812390d4d417844ec99acdc", + "openapi/markdown/getEnvironmentMetrics.md": "fb7ce3264e1500da24b21a07b5b180110fa573fc3fb476c146f4529c16e7c089", "openapi/markdown/getEnvironmentVariables.md": "12803bbc7e3f2638e16f013ce05b2a688d8085739e38049c1022452fd7881e50", - "openapi/markdown/getSandbox.md": "697dcedd7f51a776705eae4e0ea0c358f93da5d7408fae0e779a7eba39c88130", - "openapi/markdown/getSandboxLogs.md": "d5e3adfca5ff72d3b04ad8f2f5bb038ce429d8d7381cc37db33c9b4f393df047", - "openapi/markdown/getSandboxMetrics.md": "cc810ac8bd47c0bf3903a2a529d5489af61611cb7268ef2327f93007d08d9467", - "openapi/markdown/getTeamMetrics.md": "8cdaab8e8e3f089793e75ce6e831ee4effec72acf4f9297644503e175fc25368", - "openapi/markdown/getTeamMetricsMax.md": "ec55664edb022a0d60573c0500a4d47c78a34a3a2cd538b842438fb569c97cb8", - "openapi/markdown/getTemplate.md": "08d46844ebf9a8825375faa3ff447d4f79fd36d421e9ab576ca9aed266b861c6", - "openapi/markdown/getTemplateBuildLogs.md": "a9a58101cfbb8317a2cbfb0bf8ba35cfdb237cb318c1010309fc34e74da81052", - "openapi/markdown/getTemplateBuildStatus.md": "d27fafb869e7ec31271b71f54e82bd166f0548cafffbe3614d9b6bed9381f26b", - "openapi/markdown/getTemplateByAlias.md": "df84543b45bdff8db21e5084eb046b0cc46333d0a18dd296c04f9639a1ad6d71", - "openapi/markdown/getTemplateUploadUrl.md": "c93f0d82af88a13effcc1f99a327f65a404b30f94af44e9ce548c5bc2369163b", - "openapi/markdown/killSandbox.md": "bee51c4cbd21bcd055206ea7bd4adb348e9443e732ed58b6e6dd67b184838fcc", - "openapi/markdown/listSandboxMetrics.md": "91d7a84253345fc106b8aba88ee186d012530a631a23de088155705a51b9c8f9", - "openapi/markdown/listSandboxes.md": "dc9411c3f5014b70689a4391d2d6b005426cb629eda61c097a2491fbab1a0ee7", - "openapi/markdown/listSnapshots.md": "5aa146fc317fcf7ccb730041e9cf9eb86e0345bce0a5527041ce38b747a750da", - "openapi/markdown/listTemplateTags.md": "40639fca4f9bc1be9df4d062f41a85c75f171ed323455f848002fce6af1d4805", - "openapi/markdown/listTemplates.md": "981cf6aa70140ff88845f00abd741b1e4feacc11f0916015bc68e7e5e75fc434", - "openapi/markdown/pauseSandbox.md": "1dcad5a2c9deb444120e5ec2812e14d3a90b9ed1db557f5d5d0eb05035695acf", - "openapi/markdown/refreshSandbox.md": "445154db7266e2b111a98d164c6ce75432b7ffa01db66245deed487ce79605e6", - "openapi/markdown/setSandboxTimeout.md": "0a093a4a42241cd2945c966b94e78d1e04d62315a475acba3430655a6a201591", - "openapi/markdown/startTemplateBuild.md": "35d876994087cab1fbb8ae5251c66f952a9ce89425457afcc86ba4daefa256a5", - "openapi/markdown/updateSandboxNetwork.md": "30717801dfc58a1ddd3e7eb889af7ad2fec16ea7c6d8a13f8eb1356066165ac2", - "openapi/markdown/updateTemplate.md": "0e18de978fc7005ec36645d003827354df933fb9e51ba218fbdea55639c0636a", - "openapi/markdown/uploadFile.md": "acf5f7029d2b4de2ce96b50bb24f5e4495c188dfed878851ffe2f91e5b7b24d3", - "openapi/operations.json": "1593bd80b73d87117a5ebf8211d0ba014e0170c84fca5fe9f1a82ec457a6b575", + "openapi/markdown/getSandbox.md": "9e9f1200583b9abb206e7c69e9d4157403297042d2dd1e57e5bd804962073a91", + "openapi/markdown/getSandboxLogs.md": "6641f57b0ef9f7e029b66deb472616ea4abe54f3884b3021bfcf97b37920a598", + "openapi/markdown/getSandboxMetrics.md": "1572d44d0ff539495dadcbb909bb1e640b73375fcb4b0840243e692066162ace", + "openapi/markdown/getTeamMetrics.md": "063860650df86f09f1119f441b1410b1e329dd20000cf1b1f8a1f84fdcbdac53", + "openapi/markdown/getTeamMetricsMax.md": "5e5e6578470d1710c993ae69a91b34badaaa86e62e141eb91e57c6e0f7594fe6", + "openapi/markdown/getTemplate.md": "fa972635535ecb1b19324216185f75c90fe81520ed79dc7e20a0894306e054b3", + "openapi/markdown/getTemplateBuildLogs.md": "c1dc222e7ab5268897e8fdda893d1264ac9162db146fb89bbe6c9833f350ab7f", + "openapi/markdown/getTemplateBuildStatus.md": "26741b144d7ce26f353173bd0665b30925e6161d914317fb994bae5c2b4d0d3d", + "openapi/markdown/getTemplateByAlias.md": "2a42010266038d50581e3526becf1f35ad3ada6eecd757522b083817fe435301", + "openapi/markdown/getTemplateUploadUrl.md": "b06cb4aaed389e75daa8e509e3437a23915aad2b03ef6e69597df67984a48b19", + "openapi/markdown/killSandbox.md": "c864528a36849a512be77bf144ef7d41356f01cb0dbbe1d2f5143712a95268f2", + "openapi/markdown/listSandboxMetrics.md": "b945d76f80dc2fef506d2f21183bca49ddb045773b8895b6412e435e5c9d6d7f", + "openapi/markdown/listSandboxes.md": "7744505b60b94d1c8db8c1b7a1a66bcf9bdb8f51a46b13b5a90349e562924f59", + "openapi/markdown/listSnapshots.md": "d7f7ae67491c5da2930181b0fe423ef8ad661f5f4e7e88f47ecfb58cb08ac83f", + "openapi/markdown/listTemplateTags.md": "df27ed0dc04e6b49a3dc92704842e30365f50e88c8e28e6a5323a16aa10b7c45", + "openapi/markdown/listTemplates.md": "e89b7d18efcfa6e16385e6b4e2f227ad2e5c9fa7608426ece673077a35468e12", + "openapi/markdown/pauseSandbox.md": "0d1e7dd52ca966d37742e7d34898559dfd03c4ba3ca7f83f1859ddaefa9b0464", + "openapi/markdown/refreshSandbox.md": "dea1862241aad45c17b194994722a23941263bb697b885e795ba97cf154469bd", + "openapi/markdown/setSandboxTimeout.md": "ee0aaf78e2c0ffcdf4df1bde703fd4442d5436efad290bc235d1acc120adb997", + "openapi/markdown/startTemplateBuild.md": "befd11983028352bd7bf727113deb9bbb7d86d7b02385441111f4de46087173c", + "openapi/markdown/updateSandboxNetwork.md": "3449bd43a4e46c35d3f8ec314a47876ec06f85a8a75e4255212a85cb7a4c3e53", + "openapi/markdown/updateTemplate.md": "ace7930be4091213fc2e29a7109f489eaaf3a0e1d210aa65d9663a5adbf92250", + "openapi/markdown/uploadFile.md": "fe1dcc1b1eaad25ecd73f8c00a49c94ca7c2686fbdb6f3e2fbbebbfec6928806", + "openapi/operations.json": "f5097d93fb7eb5f6482e632624d5a212e29441ef8c558601ccbe2dae26db050d", "sdk/cli/auth.md": "0b2c75262b0c0670c7bc0f0f3cbed65fbe4a16d6fe4437789a5685b8bf2174a1", "sdk/cli/sandbox.md": "16b64c5a4e932eca2452e400e0faf154eba1d3c7373513aa7cd9744e02908313", "sdk/cli/template.md": "f270b22b9ee10a9b954a14f24e04c5449b4d5823bb28002ffde3ed682594cfc5", diff --git a/reference/openapi/markdown/assignTemplateTags.md b/reference/openapi/markdown/assignTemplateTags.md index a451a7e2..6dbc575f 100644 --- a/reference/openapi/markdown/assignTemplateTags.md +++ b/reference/openapi/markdown/assignTemplateTags.md @@ -12,10 +12,13 @@ Required: yes Schema: `AssignTemplateTagsRequest` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `target` | `string` | yes | Target template in "name:tag" format | -| `tags` | `array` | yes | Tags to assign to the template | +- **`target`** · `string` · required + + Target template in "name:tag" format + +- **`tags`** · `array` · required + + Tags to assign to the template ## Responses @@ -27,10 +30,13 @@ Content-Type: `application/json` Schema: `AssignedTemplateTags` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `tags` | `array` | yes | Assigned tags of the template | -| `buildID` | `string` | yes | Identifier of the build associated with these tags | +- **`tags`** · `array` · required + + Assigned tags of the template + +- **`buildID`** · `string` · required + + Identifier of the build associated with these tags ### 400 @@ -40,10 +46,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -53,10 +62,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -66,10 +78,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -79,7 +94,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/composeFiles.md b/reference/openapi/markdown/composeFiles.md index e3e23674..41ea5efd 100644 --- a/reference/openapi/markdown/composeFiles.md +++ b/reference/openapi/markdown/composeFiles.md @@ -10,11 +10,17 @@ Required: yes Schema: `ComposeRequest` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `source_paths` | `array` | yes | Ordered list of source file paths to concatenate | -| `destination` | `string` | yes | Destination file path for the composed file | -| `username` | `string` | no | User for setting ownership and resolving relative paths | +- **`source_paths`** · `array` · required + + Ordered list of source file paths to concatenate + +- **`destination`** · `string` · required + + Destination file path for the composed file + +- **`username`** · `string` · optional + + User for setting ownership and resolving relative paths ## Responses @@ -26,12 +32,21 @@ Content-Type: `application/json` Schema: `EntryInfo` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `path` | `string` | yes | Path to the file | -| `name` | `string` | yes | Name of the file | -| `type` | `file` | yes | Type of the file | -| `metadata` | `object` | no | User-defined metadata stored as extended attributes on the file. | +- **`path`** · `string` · required + + Path to the file + +- **`name`** · `string` · required + + Name of the file + +- **`type`** · `file` · required + + Type of the file + +- **`metadata`** · `object` · optional + + User-defined metadata stored as extended attributes on the file. ### 400 @@ -41,10 +56,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code ### 401 @@ -54,10 +72,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code ### 404 @@ -67,10 +88,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code ### 500 @@ -80,10 +104,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code ### 507 @@ -93,7 +120,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code diff --git a/reference/openapi/markdown/connectSandbox.md b/reference/openapi/markdown/connectSandbox.md index c4e6d545..b71e7204 100644 --- a/reference/openapi/markdown/connectSandbox.md +++ b/reference/openapi/markdown/connectSandbox.md @@ -6,9 +6,7 @@ Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is on ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandboxID` | path | yes | `string` | | +- **`sandboxID`** · `string` · path · required ## Request body @@ -18,9 +16,9 @@ Required: yes Schema: `ConnectSandbox` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `timeout` | `integer` | yes | Timeout in seconds from the current time after which the sandbox should expire | +- **`timeout`** · `integer` · required + + Timeout in seconds from the current time after which the sandbox should expire ## Responses @@ -32,13 +30,25 @@ Content-Type: `application/json` Schema: `Sandbox` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `templateID` | `string` | yes | Identifier of the template from which is the sandbox created | -| `sandboxID` | `string` | yes | Identifier of the sandbox | -| `alias` | `string` | no | Alias of the template | -| `envdVersion` | `EnvdVersion` | yes | Version of the envd running in the sandbox | -| `domain` | `string` | no | Base domain where the sandbox traffic is accessible | +- **`templateID`** · `string` · required + + Identifier of the template from which is the sandbox created + +- **`sandboxID`** · `string` · required + + Identifier of the sandbox + +- **`alias`** · `string` · optional + + Alias of the template + +- **`envdVersion`** · `EnvdVersion` · required + + Version of the envd running in the sandbox + +- **`domain`** · `string` · optional + + Base domain where the sandbox traffic is accessible ### 201 @@ -48,13 +58,25 @@ Content-Type: `application/json` Schema: `Sandbox` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `templateID` | `string` | yes | Identifier of the template from which is the sandbox created | -| `sandboxID` | `string` | yes | Identifier of the sandbox | -| `alias` | `string` | no | Alias of the template | -| `envdVersion` | `EnvdVersion` | yes | Version of the envd running in the sandbox | -| `domain` | `string` | no | Base domain where the sandbox traffic is accessible | +- **`templateID`** · `string` · required + + Identifier of the template from which is the sandbox created + +- **`sandboxID`** · `string` · required + + Identifier of the sandbox + +- **`alias`** · `string` · optional + + Alias of the template + +- **`envdVersion`** · `EnvdVersion` · required + + Version of the envd running in the sandbox + +- **`domain`** · `string` · optional + + Base domain where the sandbox traffic is accessible ### 400 @@ -64,10 +86,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -77,10 +102,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -90,10 +118,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -103,7 +134,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/createSandbox.md b/reference/openapi/markdown/createSandbox.md index e786c16a..ec627b95 100644 --- a/reference/openapi/markdown/createSandbox.md +++ b/reference/openapi/markdown/createSandbox.md @@ -12,20 +12,47 @@ Required: yes Schema: `NewSandbox` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `templateID` | `string` | yes | Identifier of the required template | -| `timeout` | `integer` | no | Time to live for the sandbox in seconds. | -| `autoPause` | `boolean` | no | Automatically pauses the sandbox after the timeout | -| `autoPauseMemory` | `boolean` | no | 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). | -| `autoResume` | `SandboxAutoResumeConfig` | no | Auto-resume configuration for paused sandboxes. | -| `secure` | `boolean` | no | Secure all system communication with sandbox | -| `allow_internet_access` | `boolean` | no | Allow sandbox to access the internet. When set to false, it behaves the same as specifying denyOut to 0.0.0.0/0 in the network config. | -| `network` | `SandboxNetworkConfig` | no | | -| `metadata` | `SandboxMetadata` | no | | -| `envVars` | `EnvVars` | no | | -| `mcp` | `Mcp` | no | MCP configuration for the sandbox | -| `iam` | `SandboxIam` | no | Sandbox workload identity configuration. A non-empty, valid tokens map enables workload identity for the sandbox. | +- **`templateID`** · `string` · required + + Identifier of the required template + +- **`timeout`** · `integer` · optional + + Time to live for the sandbox in seconds. + +- **`autoPause`** · `boolean` · optional + + Automatically pauses the sandbox after the timeout + +- **`autoPauseMemory`** · `boolean` · optional + + 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). + +- **`autoResume`** · `SandboxAutoResumeConfig` · optional + + Auto-resume configuration for paused sandboxes. + +- **`secure`** · `boolean` · optional + + Secure all system communication with sandbox + +- **`allow_internet_access`** · `boolean` · optional + + Allow sandbox to access the internet. When set to false, it behaves the same as specifying denyOut to 0.0.0.0/0 in the network config. + +- **`network`** · `SandboxNetworkConfig` · optional + +- **`metadata`** · `SandboxMetadata` · optional + +- **`envVars`** · `EnvVars` · optional + +- **`mcp`** · `Mcp` · optional + + MCP configuration for the sandbox + +- **`iam`** · `SandboxIam` · optional + + Sandbox workload identity configuration. A non-empty, valid tokens map enables workload identity for the sandbox. ## Responses @@ -37,13 +64,25 @@ Content-Type: `application/json` Schema: `Sandbox` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `templateID` | `string` | yes | Identifier of the template from which is the sandbox created | -| `sandboxID` | `string` | yes | Identifier of the sandbox | -| `alias` | `string` | no | Alias of the template | -| `envdVersion` | `EnvdVersion` | yes | Version of the envd running in the sandbox | -| `domain` | `string` | no | Base domain where the sandbox traffic is accessible | +- **`templateID`** · `string` · required + + Identifier of the template from which is the sandbox created + +- **`sandboxID`** · `string` · required + + Identifier of the sandbox + +- **`alias`** · `string` · optional + + Alias of the template + +- **`envdVersion`** · `EnvdVersion` · required + + Version of the envd running in the sandbox + +- **`domain`** · `string` · optional + + Base domain where the sandbox traffic is accessible ### 401 @@ -53,10 +92,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 400 @@ -66,10 +108,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -79,7 +124,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/createSnapshot.md b/reference/openapi/markdown/createSnapshot.md index d98014d1..988c1b8f 100644 --- a/reference/openapi/markdown/createSnapshot.md +++ b/reference/openapi/markdown/createSnapshot.md @@ -6,9 +6,7 @@ Create a persistent snapshot from the sandbox's current state. Snapshots can be ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandboxID` | path | yes | `string` | | +- **`sandboxID`** · `string` · path · required ## Request body @@ -18,9 +16,9 @@ Required: yes Schema: `SandboxSnapshotRequest` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `name` | `string` | no | Optional name for the snapshot template. If a snapshot template with this name already exists, a new build will be assigned to the existing template instead of creating a new one. | +- **`name`** · `string` · optional + + Optional name for the snapshot template. If a snapshot template with this name already exists, a new build will be assigned to the existing template instead of creating a new one. ## Responses @@ -32,10 +30,13 @@ Content-Type: `application/json` Schema: `SnapshotInfo` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `snapshotID` | `string` | yes | Identifier of the snapshot template including the tag. Uses namespace/alias when a name was provided (e.g. team-slug/my-snapshot:default), otherwise falls back to the raw template ID (e.g. abc123:default). | -| `names` | `array` | yes | Full names of the snapshot template including team namespace and tag (e.g. team-slug/my-snapshot:v2) | +- **`snapshotID`** · `string` · required + + Identifier of the snapshot template including the tag. Uses namespace/alias when a name was provided (e.g. team-slug/my-snapshot:default), otherwise falls back to the raw template ID (e.g. abc123:default). + +- **`names`** · `array` · required + + Full names of the snapshot template including team namespace and tag (e.g. team-slug/my-snapshot:v2) ### 400 @@ -45,10 +46,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -58,10 +62,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -71,10 +78,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -84,7 +94,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/createTemplate.md b/reference/openapi/markdown/createTemplate.md index 9cc0e0dd..a8c4c5c0 100644 --- a/reference/openapi/markdown/createTemplate.md +++ b/reference/openapi/markdown/createTemplate.md @@ -12,12 +12,21 @@ Required: yes Schema: `TemplateBuildRequestV3` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `name` | `string` | no | 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. | -| `tags` | `array` | no | Tags to assign to the template build | -| `cpuCount` | `CPUCount` | no | CPU cores for the sandbox | -| `memoryMB` | `MemoryMB` | no | Memory for the sandbox in MiB | +- **`name`** · `string` · optional + + 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. + +- **`tags`** · `array` · optional + + Tags to assign to the template build + +- **`cpuCount`** · `CPUCount` · optional + + CPU cores for the sandbox + +- **`memoryMB`** · `MemoryMB` · optional + + Memory for the sandbox in MiB ## Responses @@ -29,13 +38,25 @@ Content-Type: `application/json` Schema: `TemplateRequestResponseV3` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `templateID` | `string` | yes | Identifier of the template | -| `buildID` | `string` | yes | Identifier of the last successful build for given template | -| `public` | `boolean` | yes | Whether the template is public or only accessible by the team | -| `names` | `array` | yes | Names of the template | -| `tags` | `array` | yes | Tags assigned to the template build | +- **`templateID`** · `string` · required + + Identifier of the template + +- **`buildID`** · `string` · required + + Identifier of the last successful build for given template + +- **`public`** · `boolean` · required + + Whether the template is public or only accessible by the team + +- **`names`** · `array` · required + + Names of the template + +- **`tags`** · `array` · required + + Tags assigned to the template build ### 400 @@ -45,10 +66,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -58,10 +82,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 403 @@ -71,10 +98,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -84,7 +114,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/deleteTemplate.md b/reference/openapi/markdown/deleteTemplate.md index 0605ffb7..8b623956 100644 --- a/reference/openapi/markdown/deleteTemplate.md +++ b/reference/openapi/markdown/deleteTemplate.md @@ -6,9 +6,7 @@ Delete a template ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `templateID` | path | yes | `string` | | +- **`templateID`** · `string` · path · required ## Responses @@ -24,10 +22,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -37,7 +38,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/deleteTemplateTags.md b/reference/openapi/markdown/deleteTemplateTags.md index ce46d65c..4f8cba8b 100644 --- a/reference/openapi/markdown/deleteTemplateTags.md +++ b/reference/openapi/markdown/deleteTemplateTags.md @@ -12,10 +12,13 @@ Required: yes Schema: `DeleteTemplateTagsRequest` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `name` | `string` | yes | Name of the template | -| `tags` | `array` | yes | Tags to delete | +- **`name`** · `string` · required + + Name of the template + +- **`tags`** · `array` · required + + Tags to delete ## Responses @@ -31,10 +34,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -44,10 +50,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -57,10 +66,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -70,7 +82,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/downloadFile.md b/reference/openapi/markdown/downloadFile.md index 4557ea3a..fb804f78 100644 --- a/reference/openapi/markdown/downloadFile.md +++ b/reference/openapi/markdown/downloadFile.md @@ -4,12 +4,21 @@ Download a file ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `path` | query | no | `string` | Path to the file, URL encoded. Can be relative to the user's home directory (e.g. "file.txt" resolves to ~/file.txt). | -| `username` | query | no | `string` | User for setting file ownership and resolving relative paths. Defaults to the sandbox's default user. | -| `signature` | query | no | `string` | Signature used for file access permission verification. | -| `signature_expiration` | query | no | `integer` | Unix timestamp (seconds) after which the signature expires. Only used with the signature parameter. | +- **`path`** · `string` · query · optional + + Path to the file, URL encoded. Can be relative to the user's home directory (e.g. "file.txt" resolves to ~/file.txt). + +- **`username`** · `string` · query · optional + + User for setting file ownership and resolving relative paths. Defaults to the sandbox's default user. + +- **`signature`** · `string` · query · optional + + Signature used for file access permission verification. + +- **`signature_expiration`** · `integer` · query · optional + + Unix timestamp (seconds) after which the signature expires. Only used with the signature parameter. ## Responses @@ -29,10 +38,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code ### 401 @@ -42,10 +54,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code ### 404 @@ -55,10 +70,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code ### 406 @@ -68,10 +86,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code ### 500 @@ -81,7 +102,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `message` | `string` | yes | Error message | -| `code` | `integer` | yes | Error code | +- **`message`** · `string` · required + + Error message + +- **`code`** · `integer` · required + + Error code diff --git a/reference/openapi/markdown/forkSandbox.md b/reference/openapi/markdown/forkSandbox.md index d345493d..930cb006 100644 --- a/reference/openapi/markdown/forkSandbox.md +++ b/reference/openapi/markdown/forkSandbox.md @@ -6,9 +6,7 @@ Fork the sandbox: checkpoint the running sandbox in place (it is briefly paused, ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandboxID` | path | yes | `string` | | +- **`sandboxID`** · `string` · path · required ## Request body @@ -18,10 +16,13 @@ Required: no Schema: `SandboxForkRequest` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `timeout` | `integer` | no | Time to live for the new forked sandboxes in seconds. | -| `count` | `integer` | no | Number of forked sandboxes to create. All forks boot from the same snapshot, so the snapshot is captured once regardless of count. Each fork succeeds or fails independently; the outcome of each is reported in its entry of the response list. | +- **`timeout`** · `integer` · optional + + Time to live for the new forked sandboxes in seconds. + +- **`count`** · `integer` · optional + + Number of forked sandboxes to create. All forks boot from the same snapshot, so the snapshot is captured once regardless of count. Each fork succeeds or fails independently; the outcome of each is reported in its entry of the response list. ## Responses @@ -33,6 +34,10 @@ Content-Type: `application/json` Schema: `array` +- **`sandbox`** · `Sandbox` · optional + +- **`error`** · `Error` · optional + ### 409 Conflict @@ -41,10 +46,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -54,10 +62,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -67,10 +78,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -80,7 +94,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getEnvironmentMetrics.md b/reference/openapi/markdown/getEnvironmentMetrics.md index 3c09e56a..11fdd6c1 100644 --- a/reference/openapi/markdown/getEnvironmentMetrics.md +++ b/reference/openapi/markdown/getEnvironmentMetrics.md @@ -12,15 +12,42 @@ Content-Type: `application/json` Schema: `Metrics` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `ts` | `integer` | no | Unix timestamp in UTC for current sandbox time | -| `cpu_count` | `integer` | no | Number of CPU cores | -| `cpu_used_pct` | `number` | no | CPU usage percentage | -| `mem_total` | `integer` | no | Total virtual memory in bytes | -| `mem_used` | `integer` | no | Used virtual memory in bytes | -| `mem_cache` | `integer` | no | Cached memory (page cache) in bytes | -| `mem_total_mib` | `integer` | no | Total virtual memory in MiB | -| `mem_used_mib` | `integer` | no | Used virtual memory in MiB | -| `disk_used` | `integer` | no | Used disk space in bytes | -| `disk_total` | `integer` | no | Total disk space in bytes | +- **`ts`** · `integer` · optional + + Unix timestamp in UTC for current sandbox time + +- **`cpu_count`** · `integer` · optional + + Number of CPU cores + +- **`cpu_used_pct`** · `number` · optional + + CPU usage percentage + +- **`mem_total`** · `integer` · optional + + Total virtual memory in bytes + +- **`mem_used`** · `integer` · optional + + Used virtual memory in bytes + +- **`mem_cache`** · `integer` · optional + + Cached memory (page cache) in bytes + +- **`mem_total_mib`** · `integer` · optional + + Total virtual memory in MiB + +- **`mem_used_mib`** · `integer` · optional + + Used virtual memory in MiB + +- **`disk_used`** · `integer` · optional + + Used disk space in bytes + +- **`disk_total`** · `integer` · optional + + Total disk space in bytes diff --git a/reference/openapi/markdown/getSandbox.md b/reference/openapi/markdown/getSandbox.md index 856de9de..92440830 100644 --- a/reference/openapi/markdown/getSandbox.md +++ b/reference/openapi/markdown/getSandbox.md @@ -6,9 +6,7 @@ Get a sandbox by id ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandboxID` | path | yes | `string` | | +- **`sandboxID`** · `string` · path · required ## Responses @@ -20,23 +18,61 @@ Content-Type: `application/json` Schema: `SandboxDetail` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `templateID` | `string` | yes | Identifier of the template from which is the sandbox created | -| `alias` | `string` | no | Alias of the template | -| `sandboxID` | `string` | yes | Identifier of the sandbox | -| `startedAt` | `string` | yes | Time when the sandbox was started | -| `endAt` | `string` | yes | Time when the sandbox will expire | -| `envdVersion` | `EnvdVersion` | yes | Version of the envd running in the sandbox | -| `allowInternetAccess` | `boolean` | no | Whether internet access was explicitly enabled or disabled for the sandbox. Null means it was not explicitly set. | -| `domain` | `string` | no | Base domain where the sandbox traffic is accessible | -| `cpuCount` | `CPUCount` | yes | CPU cores for the sandbox | -| `memoryMB` | `MemoryMB` | yes | Memory for the sandbox in MiB | -| `diskSizeMB` | `DiskSizeMB` | yes | Disk size for the sandbox in MiB | -| `metadata` | `SandboxMetadata` | no | | -| `state` | `SandboxState` | yes | State of the sandbox | -| `network` | `SandboxNetworkConfig` | no | | -| `lifecycle` | `SandboxLifecycle` | no | Sandbox lifecycle policy returned by sandbox info. | +- **`templateID`** · `string` · required + + Identifier of the template from which is the sandbox created + +- **`alias`** · `string` · optional + + Alias of the template + +- **`sandboxID`** · `string` · required + + Identifier of the sandbox + +- **`startedAt`** · `string` · required + + Time when the sandbox was started + +- **`endAt`** · `string` · required + + Time when the sandbox will expire + +- **`envdVersion`** · `EnvdVersion` · required + + Version of the envd running in the sandbox + +- **`allowInternetAccess`** · `boolean` · optional + + Whether internet access was explicitly enabled or disabled for the sandbox. Null means it was not explicitly set. + +- **`domain`** · `string` · optional + + Base domain where the sandbox traffic is accessible + +- **`cpuCount`** · `CPUCount` · required + + CPU cores for the sandbox + +- **`memoryMB`** · `MemoryMB` · required + + Memory for the sandbox in MiB + +- **`diskSizeMB`** · `DiskSizeMB` · required + + Disk size for the sandbox in MiB + +- **`metadata`** · `SandboxMetadata` · optional + +- **`state`** · `SandboxState` · required + + State of the sandbox + +- **`network`** · `SandboxNetworkConfig` · optional + +- **`lifecycle`** · `SandboxLifecycle` · optional + + Sandbox lifecycle policy returned by sandbox info. ### 404 @@ -46,10 +82,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -59,10 +98,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -72,7 +114,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getSandboxLogs.md b/reference/openapi/markdown/getSandboxLogs.md index c949e8b0..b8128fa8 100644 --- a/reference/openapi/markdown/getSandboxLogs.md +++ b/reference/openapi/markdown/getSandboxLogs.md @@ -6,15 +6,31 @@ Get sandbox logs ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandboxID` | path | yes | `string` | | -| `pageCursor` | query | no | `string` | Opaque continuation cursor returned as nextCursor by the previous page | -| `cursor` | query | no | `integer` | Starting timestamp of the logs that should be returned in milliseconds | -| `limit` | query | no | `integer` | Maximum number of logs that should be returned | -| `direction` | query | no | `LogsDirection` | Direction of the logs that should be returned | -| `level` | query | no | `LogLevel` | Minimum log level to return. Logs below this level are excluded | -| `search` | query | no | `string` | Case-sensitive substring match on log message content | +- **`sandboxID`** · `string` · path · required + +- **`pageCursor`** · `string` · query · optional + + Opaque continuation cursor returned as nextCursor by the previous page + +- **`cursor`** · `integer` · query · optional + + Starting timestamp of the logs that should be returned in milliseconds + +- **`limit`** · `integer` · query · optional + + Maximum number of logs that should be returned + +- **`direction`** · `LogsDirection` · query · optional + + Direction of the logs that should be returned + +- **`level`** · `LogLevel` · query · optional + + Minimum log level to return. Logs below this level are excluded + +- **`search`** · `string` · query · optional + + Case-sensitive substring match on log message content ## Responses @@ -26,10 +42,13 @@ Content-Type: `application/json` Schema: `SandboxLogsV2Response` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `logs` | `array` | yes | Sandbox logs structured | -| `nextCursor` | `string` | no | Opaque continuation cursor for the next page | +- **`logs`** · `array` · required + + Sandbox logs structured + +- **`nextCursor`** · `string` · optional + + Opaque continuation cursor for the next page ### 401 @@ -39,10 +58,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -52,10 +74,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -65,7 +90,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getSandboxMetrics.md b/reference/openapi/markdown/getSandboxMetrics.md index c609ad53..602a6f1c 100644 --- a/reference/openapi/markdown/getSandboxMetrics.md +++ b/reference/openapi/markdown/getSandboxMetrics.md @@ -6,11 +6,13 @@ Get sandbox metrics ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandboxID` | path | yes | `string` | | -| `start` | query | no | `integer` | Unix timestamp for the start of the interval, in seconds, for which the metrics | -| `end` | query | no | `integer` | | +- **`sandboxID`** · `string` · path · required + +- **`start`** · `integer` · query · optional + + Unix timestamp for the start of the interval, in seconds, for which the metrics + +- **`end`** · `integer` · query · optional ## Responses @@ -22,6 +24,38 @@ Content-Type: `application/json` Schema: `array` +- **`timestampUnix`** · `integer` · required + + Timestamp of the metric entry in Unix time (seconds since epoch) + +- **`cpuCount`** · `integer` · required + + Number of CPU cores + +- **`cpuUsedPct`** · `number` · required + + CPU usage percentage + +- **`memUsed`** · `integer` · required + + Memory used in bytes + +- **`memTotal`** · `integer` · required + + Total memory in bytes + +- **`memCache`** · `integer` · required + + Cached memory (page cache) in bytes + +- **`diskUsed`** · `integer` · required + + Disk used in bytes + +- **`diskTotal`** · `integer` · required + + Total disk space in bytes + ### 400 Bad request @@ -30,10 +64,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -43,10 +80,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -56,10 +96,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -69,7 +112,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getTeamMetrics.md b/reference/openapi/markdown/getTeamMetrics.md index a6fc57ef..a18919cc 100644 --- a/reference/openapi/markdown/getTeamMetrics.md +++ b/reference/openapi/markdown/getTeamMetrics.md @@ -6,11 +6,13 @@ Get metrics for the team ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `teamID` | path | yes | `string` | | -| `start` | query | no | `integer` | Unix timestamp for the start of the interval, in seconds, for which the metrics | -| `end` | query | no | `integer` | | +- **`teamID`** · `string` · path · required + +- **`start`** · `integer` · query · optional + + Unix timestamp for the start of the interval, in seconds, for which the metrics + +- **`end`** · `integer` · query · optional ## Responses @@ -22,6 +24,18 @@ Content-Type: `application/json` Schema: `array` +- **`timestampUnix`** · `integer` · required + + Timestamp of the metric entry in Unix time (seconds since epoch) + +- **`concurrentSandboxes`** · `integer` · required + + The number of concurrent sandboxes for the team + +- **`sandboxStartRate`** · `number` · required + + Number of sandboxes started per second + ### 400 Bad request @@ -30,10 +44,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -43,10 +60,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 403 @@ -56,10 +76,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -69,7 +92,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getTeamMetricsMax.md b/reference/openapi/markdown/getTeamMetricsMax.md index e4f4abe5..cfe44d32 100644 --- a/reference/openapi/markdown/getTeamMetricsMax.md +++ b/reference/openapi/markdown/getTeamMetricsMax.md @@ -6,12 +6,17 @@ Get the maximum metrics for the team in the given interval ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `teamID` | path | yes | `string` | | -| `start` | query | no | `integer` | Unix timestamp for the start of the interval, in seconds, for which the metrics | -| `end` | query | no | `integer` | | -| `metric` | query | yes | `concurrent_sandboxes \| sandbox_start_rate` | Metric to retrieve the maximum value for | +- **`teamID`** · `string` · path · required + +- **`start`** · `integer` · query · optional + + Unix timestamp for the start of the interval, in seconds, for which the metrics + +- **`end`** · `integer` · query · optional + +- **`metric`** · `concurrent_sandboxes | sandbox_start_rate` · query · required + + Metric to retrieve the maximum value for ## Responses @@ -23,10 +28,13 @@ Content-Type: `application/json` Schema: `MaxTeamMetric` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `timestampUnix` | `integer` | yes | Timestamp of the metric entry in Unix time (seconds since epoch) | -| `value` | `number` | yes | The maximum value of the requested metric in the given interval | +- **`timestampUnix`** · `integer` · required + + Timestamp of the metric entry in Unix time (seconds since epoch) + +- **`value`** · `number` · required + + The maximum value of the requested metric in the given interval ### 400 @@ -36,10 +44,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -49,10 +60,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 403 @@ -62,10 +76,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -75,7 +92,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getTemplate.md b/reference/openapi/markdown/getTemplate.md index d633d566..9cc53b83 100644 --- a/reference/openapi/markdown/getTemplate.md +++ b/reference/openapi/markdown/getTemplate.md @@ -6,11 +6,15 @@ List all builds for a template ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `templateID` | path | yes | `string` | | -| `nextToken` | query | no | `string` | Cursor to start the list from | -| `limit` | query | no | `integer` | Maximum number of items to return per page | +- **`templateID`** · `string` · path · required + +- **`nextToken`** · `string` · query · optional + + Cursor to start the list from + +- **`limit`** · `integer` · query · optional + + Maximum number of items to return per page ## Responses @@ -22,16 +26,37 @@ Content-Type: `application/json` Schema: `TemplateWithBuilds` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `templateID` | `string` | yes | Identifier of the template | -| `public` | `boolean` | yes | Whether the template is public or only accessible by the team | -| `names` | `array` | yes | Names of the template (namespace/alias format when namespaced) | -| `createdAt` | `string` | yes | Time when the template was created | -| `updatedAt` | `string` | yes | Time when the template was last updated | -| `lastSpawnedAt` | `string` | yes | Time when the template was last used | -| `spawnCount` | `integer` | yes | Number of times the template was used | -| `builds` | `array` | yes | List of builds for the template | +- **`templateID`** · `string` · required + + Identifier of the template + +- **`public`** · `boolean` · required + + Whether the template is public or only accessible by the team + +- **`names`** · `array` · required + + Names of the template (namespace/alias format when namespaced) + +- **`createdAt`** · `string` · required + + Time when the template was created + +- **`updatedAt`** · `string` · required + + Time when the template was last updated + +- **`lastSpawnedAt`** · `string` · required + + Time when the template was last used + +- **`spawnCount`** · `integer` · required + + Number of times the template was used + +- **`builds`** · `array` · required + + List of builds for the template ### 401 @@ -41,10 +66,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -54,7 +82,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getTemplateBuildLogs.md b/reference/openapi/markdown/getTemplateBuildLogs.md index bebe67f7..c2e07605 100644 --- a/reference/openapi/markdown/getTemplateBuildLogs.md +++ b/reference/openapi/markdown/getTemplateBuildLogs.md @@ -6,16 +6,29 @@ Get template build logs ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `templateID` | path | yes | `string` | | -| `buildID` | path | yes | `string` | | -| `pageCursor` | query | no | `string` | Opaque continuation cursor returned as nextCursor by the previous page | -| `cursor` | query | no | `integer` | Starting timestamp of the logs that should be returned in milliseconds | -| `limit` | query | no | `integer` | Maximum number of logs that should be returned | -| `direction` | query | no | `LogsDirection` | | -| `level` | query | no | `LogLevel` | | -| `source` | query | no | `LogsSource` | Source of the logs that should be returned from | +- **`templateID`** · `string` · path · required + +- **`buildID`** · `string` · path · required + +- **`pageCursor`** · `string` · query · optional + + Opaque continuation cursor returned as nextCursor by the previous page + +- **`cursor`** · `integer` · query · optional + + Starting timestamp of the logs that should be returned in milliseconds + +- **`limit`** · `integer` · query · optional + + Maximum number of logs that should be returned + +- **`direction`** · `LogsDirection` · query · optional + +- **`level`** · `LogLevel` · query · optional + +- **`source`** · `LogsSource` · query · optional + + Source of the logs that should be returned from ## Responses @@ -27,11 +40,17 @@ Content-Type: `application/json` Schema: `TemplateBuildLogsResponse` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `logs` | `array` | yes | Build logs structured | -| `nextCursor` | `string` | no | Opaque continuation cursor for the next page | -| `source` | `LogsSource` | no | Source of the logs that should be returned | +- **`logs`** · `array` · required + + Build logs structured + +- **`nextCursor`** · `string` · optional + + Opaque continuation cursor for the next page + +- **`source`** · `LogsSource` · optional + + Source of the logs that should be returned ### 401 @@ -41,10 +60,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -54,10 +76,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -67,7 +92,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getTemplateBuildStatus.md b/reference/openapi/markdown/getTemplateBuildStatus.md index 3f057ab1..e435cbd8 100644 --- a/reference/openapi/markdown/getTemplateBuildStatus.md +++ b/reference/openapi/markdown/getTemplateBuildStatus.md @@ -6,13 +6,19 @@ Get template build info ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `templateID` | path | yes | `string` | | -| `buildID` | path | yes | `string` | | -| `logsOffset` | query | no | `integer` | Index of the starting build log that should be returned with the template | -| `limit` | query | no | `integer` | Maximum number of logs that should be returned | -| `level` | query | no | `LogLevel` | | +- **`templateID`** · `string` · path · required + +- **`buildID`** · `string` · path · required + +- **`logsOffset`** · `integer` · query · optional + + Index of the starting build log that should be returned with the template + +- **`limit`** · `integer` · query · optional + + Maximum number of logs that should be returned + +- **`level`** · `LogLevel` · query · optional ## Responses @@ -24,14 +30,27 @@ Content-Type: `application/json` Schema: `TemplateBuildInfo` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `logs` | `array` | yes | Build logs | -| `logEntries` | `array` | yes | Build logs structured | -| `templateID` | `string` | yes | Identifier of the template | -| `buildID` | `string` | yes | Identifier of the build | -| `status` | `TemplateBuildStatus` | yes | Status of the template build | -| `reason` | `BuildStatusReason` | no | | +- **`logs`** · `array` · required + + Build logs + +- **`logEntries`** · `array` · required + + Build logs structured + +- **`templateID`** · `string` · required + + Identifier of the template + +- **`buildID`** · `string` · required + + Identifier of the build + +- **`status`** · `TemplateBuildStatus` · required + + Status of the template build + +- **`reason`** · `BuildStatusReason` · optional ### 401 @@ -41,10 +60,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -54,10 +76,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -67,7 +92,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getTemplateByAlias.md b/reference/openapi/markdown/getTemplateByAlias.md index f6e50807..1999b7bf 100644 --- a/reference/openapi/markdown/getTemplateByAlias.md +++ b/reference/openapi/markdown/getTemplateByAlias.md @@ -6,9 +6,7 @@ Check if template with given alias exists ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `alias` | path | yes | `string` | | +- **`alias`** · `string` · path · required ## Responses @@ -20,10 +18,13 @@ Content-Type: `application/json` Schema: `TemplateAliasResponse` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `templateID` | `string` | yes | Identifier of the template | -| `public` | `boolean` | yes | Whether the template is public or only accessible by the team | +- **`templateID`** · `string` · required + + Identifier of the template + +- **`public`** · `boolean` · required + + Whether the template is public or only accessible by the team ### 400 @@ -33,10 +34,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 403 @@ -46,10 +50,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -59,10 +66,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -72,7 +82,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/getTemplateUploadUrl.md b/reference/openapi/markdown/getTemplateUploadUrl.md index 361fceb9..84cb6f66 100644 --- a/reference/openapi/markdown/getTemplateUploadUrl.md +++ b/reference/openapi/markdown/getTemplateUploadUrl.md @@ -6,10 +6,9 @@ Get an upload link for a tar file containing build layer files ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `templateID` | path | yes | `string` | | -| `hash` | path | yes | `string` | | +- **`templateID`** · `string` · path · required + +- **`hash`** · `string` · path · required ## Responses @@ -21,10 +20,13 @@ Content-Type: `application/json` Schema: `TemplateBuildFileUpload` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `present` | `boolean` | yes | Whether the file is already present in the cache | -| `url` | `string` | no | Url where the file should be uploaded to | +- **`present`** · `boolean` · required + + Whether the file is already present in the cache + +- **`url`** · `string` · optional + + Url where the file should be uploaded to ### 400 @@ -34,10 +36,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -47,10 +52,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -60,10 +68,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -73,7 +84,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/killSandbox.md b/reference/openapi/markdown/killSandbox.md index 66cb3fb7..01401f83 100644 --- a/reference/openapi/markdown/killSandbox.md +++ b/reference/openapi/markdown/killSandbox.md @@ -6,9 +6,7 @@ Kill a sandbox ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandboxID` | path | yes | `string` | | +- **`sandboxID`** · `string` · path · required ## Responses @@ -24,10 +22,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 401 @@ -37,10 +38,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -50,7 +54,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/listSandboxMetrics.md b/reference/openapi/markdown/listSandboxMetrics.md index d814a7b3..50bb1609 100644 --- a/reference/openapi/markdown/listSandboxMetrics.md +++ b/reference/openapi/markdown/listSandboxMetrics.md @@ -6,9 +6,9 @@ List metrics for given sandboxes ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandbox_ids` | query | yes | `array` | Comma-separated list of sandbox IDs to get metrics for | +- **`sandbox_ids`** · `array` · query · required + + Comma-separated list of sandbox IDs to get metrics for ## Responses @@ -20,9 +20,7 @@ Content-Type: `application/json` Schema: `SandboxesWithMetrics` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `sandboxes` | `object` | yes | | +- **`sandboxes`** · `object` · required ### 401 @@ -32,10 +30,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 400 @@ -45,10 +46,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -58,7 +62,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/listSandboxes.md b/reference/openapi/markdown/listSandboxes.md index 3238b453..31b7ee59 100644 --- a/reference/openapi/markdown/listSandboxes.md +++ b/reference/openapi/markdown/listSandboxes.md @@ -6,12 +6,21 @@ List all sandboxes ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `metadata` | query | no | `string` | Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded. | -| `state` | query | no | `array` | Filter sandboxes by one or more states | -| `nextToken` | query | no | `string` | Cursor to start the list from | -| `limit` | query | no | `integer` | Maximum number of items to return per page | +- **`metadata`** · `string` · query · optional + + Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded. + +- **`state`** · `array` · query · optional + + Filter sandboxes by one or more states + +- **`nextToken`** · `string` · query · optional + + Cursor to start the list from + +- **`limit`** · `integer` · query · optional + + Maximum number of items to return per page ## Responses @@ -23,6 +32,48 @@ Content-Type: `application/json` Schema: `array` +- **`templateID`** · `string` · required + + Identifier of the template from which is the sandbox created + +- **`alias`** · `string` · optional + + Alias of the template + +- **`sandboxID`** · `string` · required + + Identifier of the sandbox + +- **`startedAt`** · `string` · required + + Time when the sandbox was started + +- **`endAt`** · `string` · required + + Time when the sandbox will expire + +- **`cpuCount`** · `CPUCount` · required + + CPU cores for the sandbox + +- **`memoryMB`** · `MemoryMB` · required + + Memory for the sandbox in MiB + +- **`diskSizeMB`** · `DiskSizeMB` · required + + Disk size for the sandbox in MiB + +- **`metadata`** · `SandboxMetadata` · optional + +- **`state`** · `SandboxState` · required + + State of the sandbox + +- **`envdVersion`** · `EnvdVersion` · required + + Version of the envd running in the sandbox + ### 401 Authentication error @@ -31,10 +82,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 400 @@ -44,10 +98,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -57,7 +114,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/listSnapshots.md b/reference/openapi/markdown/listSnapshots.md index d3022aae..5fddbcf0 100644 --- a/reference/openapi/markdown/listSnapshots.md +++ b/reference/openapi/markdown/listSnapshots.md @@ -6,12 +6,19 @@ List all snapshots for the team ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `sandboxID` | query | no | `string` | | -| `name` | query | no | `string` | Filter snapshots by name or ID, optionally tag-qualified (e.g. "my-snapshot", "my-team/my-snapshot" or "my-snapshot:v1"). | -| `limit` | query | no | `integer` | Maximum number of items to return per page | -| `nextToken` | query | no | `string` | Cursor to start the list from | +- **`sandboxID`** · `string` · query · optional + +- **`name`** · `string` · query · optional + + Filter snapshots by name or ID, optionally tag-qualified (e.g. "my-snapshot", "my-team/my-snapshot" or "my-snapshot:v1"). + +- **`limit`** · `integer` · query · optional + + Maximum number of items to return per page + +- **`nextToken`** · `string` · query · optional + + Cursor to start the list from ## Responses @@ -23,6 +30,14 @@ Content-Type: `application/json` Schema: `array` +- **`snapshotID`** · `string` · required + + Identifier of the snapshot template including the tag. Uses namespace/alias when a name was provided (e.g. team-slug/my-snapshot:default), otherwise falls back to the raw template ID (e.g. abc123:default). + +- **`names`** · `array` · required + + Full names of the snapshot template including team namespace and tag (e.g. team-slug/my-snapshot:v2) + ### 401 Authentication error @@ -31,10 +46,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -44,7 +62,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/listTemplateTags.md b/reference/openapi/markdown/listTemplateTags.md index 102da9d4..c4440abb 100644 --- a/reference/openapi/markdown/listTemplateTags.md +++ b/reference/openapi/markdown/listTemplateTags.md @@ -6,9 +6,7 @@ List all tags for a template ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `templateID` | path | yes | `string` | | +- **`templateID`** · `string` · path · required ## Responses @@ -20,6 +18,18 @@ Content-Type: `application/json` Schema: `array` +- **`tag`** · `string` · required + + The tag name + +- **`buildID`** · `string` · required + + Identifier of the build associated with this tag + +- **`createdAt`** · `string` · required + + Time when the tag was assigned + ### 401 Authentication error @@ -28,10 +38,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 403 @@ -41,10 +54,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 404 @@ -54,10 +70,13 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error ### 500 @@ -67,7 +86,10 @@ Content-Type: `application/json` Schema: `Error` -| Field | Type | Required | Description | -| --- | --- | --- | --- | -| `code` | `integer` | yes | Error code | -| `message` | `string` | yes | Error | +- **`code`** · `integer` · required + + Error code + +- **`message`** · `string` · required + + Error diff --git a/reference/openapi/markdown/listTemplates.md b/reference/openapi/markdown/listTemplates.md index 44bbec7c..cfa70e70 100644 --- a/reference/openapi/markdown/listTemplates.md +++ b/reference/openapi/markdown/listTemplates.md @@ -6,11 +6,15 @@ List all templates ## Parameters -| Name | In | Required | Type | Description | -| --- | --- | --- | --- | --- | -| `teamID` | query | no | `string` | | -| `nextToken` | query | no | `string` | Cursor to start the list from | -| `limit` | query | no | `integer` | Maximum number of items to return per page | +- **`teamID`** · `string` · query · optional + +- **`nextToken`** · `string` · query · optional + + Cursor to start the list from + +- **`limit`** · `integer` · query · optional + + Maximum number of items to return per page ## Responses @@ -22,6 +26,64 @@ Content-Type: `application/json` Schema: `array