From 686aaa6aada5bd978dfe855eba66352b8f5c2532 Mon Sep 17 00:00:00 2001 From: Ilyas Salikhov Date: Mon, 31 Aug 2026 15:49:05 +0300 Subject: [PATCH 1/2] fix(reference): publish curated SDK contract --- .../javascript/code-interpreter.ts | 28 + reference-config/javascript/commands.ts | 14 + reference-config/javascript/errors.ts | 13 + reference-config/javascript/filesystem.ts | 10 + reference-config/javascript/logger.ts | 7 + reference-config/javascript/ready-commands.ts | 8 + reference-config/javascript/sandbox.ts | 37 + reference-config/javascript/templates.ts | 15 + reference-config/sdk-groups.json | 47 +- .../typedoc.code-interpreter.json | 6 +- reference-config/typedoc.js-sdk.json | 9 + reference/manifest.json | 299 ++-- .../openapi/markdown/assignTemplateTags.md | 85 + reference/openapi/markdown/composeFiles.md | 99 + reference/openapi/markdown/connectSandbox.md | 115 ++ reference/openapi/markdown/createSandbox.md | 89 + reference/openapi/markdown/createSnapshot.md | 90 + reference/openapi/markdown/createTemplate.md | 93 + reference/openapi/markdown/deleteTemplate.md | 43 + .../openapi/markdown/deleteTemplateTags.md | 76 + reference/openapi/markdown/downloadFile.md | 87 + reference/openapi/markdown/forkSandbox.md | 86 + .../openapi/markdown/getEnvironmentHealth.md | 9 + .../openapi/markdown/getEnvironmentMetrics.md | 26 + .../markdown/getEnvironmentVariables.md | 13 + reference/openapi/markdown/getSandbox.md | 81 + reference/openapi/markdown/getSandboxLogs.md | 71 + .../openapi/markdown/getSandboxMetrics.md | 75 + reference/openapi/markdown/getTeamMetrics.md | 75 + .../openapi/markdown/getTeamMetricsMax.md | 82 + reference/openapi/markdown/getTemplate.md | 61 + .../openapi/markdown/getTemplateBuildLogs.md | 73 + .../markdown/getTemplateBuildStatus.md | 73 + .../openapi/markdown/getTemplateByAlias.md | 78 + .../openapi/markdown/getTemplateUploadUrl.md | 79 + reference/openapi/markdown/killSandbox.md | 56 + .../openapi/markdown/listSandboxMetrics.md | 64 + reference/openapi/markdown/listSandboxes.md | 63 + reference/openapi/markdown/listSnapshots.md | 50 + .../openapi/markdown/listTemplateTags.md | 73 + reference/openapi/markdown/listTemplates.md | 75 + reference/openapi/markdown/pauseSandbox.md | 81 + reference/openapi/markdown/refreshSandbox.md | 55 + .../openapi/markdown/setSandboxTimeout.md | 68 + .../openapi/markdown/startTemplateBuild.md | 62 + .../openapi/markdown/updateSandboxNetwork.md | 84 + reference/openapi/markdown/updateTemplate.md | 76 + reference/openapi/markdown/uploadFile.md | 111 ++ reference/openapi/operations.json | 108 +- .../sdk/javascript/code-interpreter/README.md | 42 +- .../code-interpreter/charts/README.md | 27 - .../charts/functions/deserializeChart.md | 15 - .../{sandbox => }/classes/Sandbox.md | 10 +- .../{charts => }/enumerations/ChartType.md | 2 +- .../{charts => }/enumerations/ScaleType.md | 2 +- .../interfaces/CreateCodeContextOpts.md | 2 +- .../classes => interfaces}/Execution.md | 40 +- .../interfaces/ExecutionError.md | 30 + .../interfaces/OutputMessage.md | 39 + .../classes => interfaces}/Result.md | 26 +- .../{sandbox => }/interfaces/RunCodeOpts.md | 10 +- .../code-interpreter/messaging/README.md | 21 - .../messaging/classes/ExecutionError.md | 60 - .../messaging/classes/OutputMessage.md | 69 - .../messaging/functions/extractError.md | 15 - .../messaging/functions/parseOutput.md | 35 - .../messaging/type-aliases/MIMEType.md | 7 - .../code-interpreter/sandbox/README.md | 17 - .../{charts => }/type-aliases/BarChart.md | 2 +- .../{charts => }/type-aliases/BarData.md | 2 +- .../type-aliases/BoxAndWhiskerChart.md | 2 +- .../type-aliases/BoxAndWhiskerData.md | 2 +- .../{charts => }/type-aliases/Chart.md | 2 +- .../{charts => }/type-aliases/ChartTypes.md | 2 +- .../{sandbox => }/type-aliases/Context.md | 2 +- .../{charts => }/type-aliases/LineChart.md | 2 +- .../{messaging => }/type-aliases/Logs.md | 2 +- .../code-interpreter/type-aliases/MIMEType.md | 7 + .../{charts => }/type-aliases/PieChart.md | 2 +- .../{charts => }/type-aliases/PieData.md | 2 +- .../{charts => }/type-aliases/PointData.md | 2 +- .../{messaging => }/type-aliases/RawData.md | 2 +- .../type-aliases/RunCodeLanguage.md | 2 +- .../{charts => }/type-aliases/ScatterChart.md | 2 +- .../{charts => }/type-aliases/SuperChart.md | 2 +- reference/sdk/javascript/commands/README.md | 12 +- .../commands/classes/CommandExitError.md | 271 +++ .../commands/interfaces/CommandHandle.md | 196 ++ .../commands/interfaces/CommandRequestOpts.md | 2 +- .../commands/interfaces/CommandResult.md | 38 + .../commands/interfaces/CommandStartOpts.md | 6 +- .../{classes => interfaces}/Commands.md | 66 +- .../commands/interfaces/ProcessInfo.md | 2 +- .../commands/{classes => interfaces}/Pty.md | 36 +- .../type-aliases/CommandConnectOpts.md | 2 +- .../commands/type-aliases/PtyOutput.md | 5 + .../commands/type-aliases/Stderr.md | 5 + .../commands/type-aliases/Stdout.md | 5 + reference/sdk/javascript/errors/README.md | 6 +- .../errors/classes/AuthenticationError.md | 2 +- .../javascript/errors/classes/BuildError.md | 2 +- .../errors/classes/FileNotFoundError.md | 2 +- .../errors/classes/FileUploadError.md | 2 +- .../errors/classes/InvalidArgumentError.md | 2 +- .../errors/classes/NotEnoughSpaceError.md | 2 +- .../errors/classes/RateLimitError.md | 2 +- .../javascript/errors/classes/SandboxError.md | 8 +- .../errors/classes/SandboxNotFoundError.md | 2 +- .../errors/classes/TemplateError.md | 2 +- .../javascript/errors/classes/TimeoutError.md | 2 +- .../functions/formatSandboxTimeoutError.md | 15 - reference/sdk/javascript/filesystem/README.md | 21 +- .../filesystem/enumerations/FileType.md | 2 +- .../enumerations/FilesystemEventType.md | 45 + .../filesystem/functions/mapEntryInfo.md | 17 - .../filesystem/interfaces/EntryInfo.md | 2 +- .../{classes => interfaces}/Filesystem.md | 88 +- .../filesystem/interfaces/FilesystemEvent.md | 33 + .../interfaces/FilesystemListOpts.md | 62 - .../interfaces/FilesystemReadOpts.md | 10 +- .../interfaces/FilesystemRequestOpts.md | 57 - .../interfaces/FilesystemWriteOpts.md | 10 +- .../filesystem/interfaces/WatchHandle.md | 19 + .../filesystem/interfaces/WatchOpts.md | 122 -- .../filesystem/interfaces/WriteInfo.md | 2 +- .../filesystem/type-aliases/WriteEntry.md | 17 - reference/sdk/javascript/logger/README.md | 6 +- .../sdk/javascript/logger/classes/LogEntry.md | 4 +- .../javascript/logger/classes/LogEntryEnd.md | 2 +- .../logger/classes/LogEntryStart.md | 2 +- .../logger/functions/defaultBuildLogger.md | 2 +- .../javascript/logger/interfaces/Logger.md | 77 + .../logger/type-aliases/LogEntryLevel.md | 2 +- .../sdk/javascript/ready-commands/README.md | 2 +- .../ready-commands/classes/ReadyCmd.md | 2 +- .../ready-commands/functions/waitForFile.md | 2 +- .../ready-commands/functions/waitForPort.md | 2 +- .../functions/waitForProcess.md | 2 +- .../functions/waitForTimeout.md | 2 +- .../ready-commands/functions/waitForURL.md | 2 +- reference/sdk/javascript/sandbox/README.md | 48 +- .../javascript/sandbox/classes/AgentBox.md | 65 + .../sandbox/{index => }/classes/Sandbox.md | 128 +- .../sdk/javascript/sandbox/index/README.md | 11 - .../index/interfaces/SandboxUrlOpts.md | 22 - .../interfaces/CreateSnapshotOpts.md | 2 +- .../sandbox/interfaces/McpServer.md | 1591 +++++++++++++++++ .../interfaces/SandboxApiOpts.md | 6 +- .../interfaces/SandboxForkOpts.md | 2 +- .../interfaces/SandboxIamOpts.md | 2 +- .../interfaces/SandboxIamToken.md | 2 +- .../interfaces/SandboxInfo.md | 2 +- .../interfaces/SandboxListOpts.md | 2 +- .../interfaces/SandboxMetrics.md | 2 +- .../interfaces/SandboxMetricsOpts.md | 2 +- .../interfaces/SandboxOpts.md | 4 +- .../SandboxPaginator.md | 34 +- .../interfaces/SandboxPauseOpts.md | 2 +- .../interfaces/SnapshotInfo.md | 2 +- .../interfaces/SnapshotListOpts.md | 2 +- .../SnapshotPaginator.md | 34 +- .../javascript/sandbox/sandboxApi/README.md | 47 - .../sandbox/sandboxApi/classes/SandboxApi.md | 363 ---- .../type-aliases/GitHubMcpServer.md | 9 - .../sandboxApi/type-aliases/McpServer.md | 8 - .../type-aliases/AgentBoxClientOpts.md | 10 + .../type-aliases/SandboxConnectOpts.md | 2 +- .../type-aliases/SandboxIamTokenType.md | 2 +- .../type-aliases/SandboxInfoLifecycle.md | 2 +- .../type-aliases/SandboxLifecycle.md | 2 +- .../type-aliases/SandboxNetworkInfo.md | 2 +- .../type-aliases/SandboxNetworkOpts.md | 2 +- .../type-aliases/SandboxNetworkRule.md | 2 +- .../type-aliases/SandboxNetworkRuleInfo.md | 2 +- .../type-aliases/SandboxNetworkRules.md | 2 +- .../type-aliases/SandboxNetworkSelector.md | 2 +- .../SandboxNetworkSelectorContext.md | 2 +- .../type-aliases/SandboxNetworkTransform.md | 2 +- .../SandboxNetworkTransformContext.md | 2 +- .../SandboxNetworkTransformResolver.md | 2 +- .../type-aliases/SandboxNetworkUpdate.md | 4 +- .../type-aliases/SandboxOnTimeout.md | 2 +- .../type-aliases/SandboxState.md | 2 +- reference/sdk/javascript/templates/README.md | 2 +- .../templates/classes/TemplateBase.md | 2 +- .../templates/interfaces/TemplateBuilder.md | 2 +- .../templates/type-aliases/BuildInfo.md | 2 +- .../templates/type-aliases/BuildOptions.md | 2 +- .../type-aliases/BuildStatusReason.md | 2 +- .../templates/type-aliases/CopyItem.md | 2 +- .../type-aliases/GetBuildStatusOptions.md | 2 +- .../templates/type-aliases/McpServerName.md | 2 +- .../type-aliases/TemplateBuildStatus.md | 2 +- .../TemplateBuildStatusResponse.md | 2 +- .../templates/type-aliases/TemplateClass.md | 2 +- .../templates/type-aliases/TemplateTag.md | 2 +- .../templates/type-aliases/TemplateTagInfo.md | 2 +- .../templates/variables/Template.md | 2 +- scripts/generate-reference.py | 144 +- scripts/test-reference-contract.py | 25 + 200 files changed, 5956 insertions(+), 1678 deletions(-) create mode 100644 reference-config/javascript/code-interpreter.ts create mode 100644 reference-config/javascript/commands.ts create mode 100644 reference-config/javascript/errors.ts create mode 100644 reference-config/javascript/filesystem.ts create mode 100644 reference-config/javascript/logger.ts create mode 100644 reference-config/javascript/ready-commands.ts create mode 100644 reference-config/javascript/sandbox.ts create mode 100644 reference-config/javascript/templates.ts create mode 100644 reference-config/typedoc.js-sdk.json create mode 100644 reference/openapi/markdown/assignTemplateTags.md create mode 100644 reference/openapi/markdown/composeFiles.md create mode 100644 reference/openapi/markdown/connectSandbox.md create mode 100644 reference/openapi/markdown/createSandbox.md create mode 100644 reference/openapi/markdown/createSnapshot.md create mode 100644 reference/openapi/markdown/createTemplate.md create mode 100644 reference/openapi/markdown/deleteTemplate.md create mode 100644 reference/openapi/markdown/deleteTemplateTags.md create mode 100644 reference/openapi/markdown/downloadFile.md create mode 100644 reference/openapi/markdown/forkSandbox.md create mode 100644 reference/openapi/markdown/getEnvironmentHealth.md create mode 100644 reference/openapi/markdown/getEnvironmentMetrics.md create mode 100644 reference/openapi/markdown/getEnvironmentVariables.md create mode 100644 reference/openapi/markdown/getSandbox.md create mode 100644 reference/openapi/markdown/getSandboxLogs.md create mode 100644 reference/openapi/markdown/getSandboxMetrics.md create mode 100644 reference/openapi/markdown/getTeamMetrics.md create mode 100644 reference/openapi/markdown/getTeamMetricsMax.md create mode 100644 reference/openapi/markdown/getTemplate.md create mode 100644 reference/openapi/markdown/getTemplateBuildLogs.md create mode 100644 reference/openapi/markdown/getTemplateBuildStatus.md create mode 100644 reference/openapi/markdown/getTemplateByAlias.md create mode 100644 reference/openapi/markdown/getTemplateUploadUrl.md create mode 100644 reference/openapi/markdown/killSandbox.md create mode 100644 reference/openapi/markdown/listSandboxMetrics.md create mode 100644 reference/openapi/markdown/listSandboxes.md create mode 100644 reference/openapi/markdown/listSnapshots.md create mode 100644 reference/openapi/markdown/listTemplateTags.md create mode 100644 reference/openapi/markdown/listTemplates.md create mode 100644 reference/openapi/markdown/pauseSandbox.md create mode 100644 reference/openapi/markdown/refreshSandbox.md create mode 100644 reference/openapi/markdown/setSandboxTimeout.md create mode 100644 reference/openapi/markdown/startTemplateBuild.md create mode 100644 reference/openapi/markdown/updateSandboxNetwork.md create mode 100644 reference/openapi/markdown/updateTemplate.md create mode 100644 reference/openapi/markdown/uploadFile.md delete mode 100644 reference/sdk/javascript/code-interpreter/charts/README.md delete mode 100644 reference/sdk/javascript/code-interpreter/charts/functions/deserializeChart.md rename reference/sdk/javascript/code-interpreter/{sandbox => }/classes/Sandbox.md (98%) rename reference/sdk/javascript/code-interpreter/{charts => }/enumerations/ChartType.md (82%) rename reference/sdk/javascript/code-interpreter/{charts => }/enumerations/ScaleType.md (85%) rename reference/sdk/javascript/code-interpreter/{sandbox => }/interfaces/CreateCodeContextOpts.md (84%) rename reference/sdk/javascript/code-interpreter/{messaging/classes => interfaces}/Execution.md (61%) create mode 100644 reference/sdk/javascript/code-interpreter/interfaces/ExecutionError.md create mode 100644 reference/sdk/javascript/code-interpreter/interfaces/OutputMessage.md rename reference/sdk/javascript/code-interpreter/{messaging/classes => interfaces}/Result.md (87%) rename reference/sdk/javascript/code-interpreter/{sandbox => }/interfaces/RunCodeOpts.md (79%) delete mode 100644 reference/sdk/javascript/code-interpreter/messaging/README.md delete mode 100644 reference/sdk/javascript/code-interpreter/messaging/classes/ExecutionError.md delete mode 100644 reference/sdk/javascript/code-interpreter/messaging/classes/OutputMessage.md delete mode 100644 reference/sdk/javascript/code-interpreter/messaging/functions/extractError.md delete mode 100644 reference/sdk/javascript/code-interpreter/messaging/functions/parseOutput.md delete mode 100644 reference/sdk/javascript/code-interpreter/messaging/type-aliases/MIMEType.md delete mode 100644 reference/sdk/javascript/code-interpreter/sandbox/README.md rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/BarChart.md (71%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/BarData.md (68%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/BoxAndWhiskerChart.md (74%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/BoxAndWhiskerData.md (81%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/Chart.md (74%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/ChartTypes.md (74%) rename reference/sdk/javascript/code-interpreter/{sandbox => }/type-aliases/Context.md (78%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/LineChart.md (65%) rename reference/sdk/javascript/code-interpreter/{messaging => }/type-aliases/Logs.md (82%) create mode 100644 reference/sdk/javascript/code-interpreter/type-aliases/MIMEType.md rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/PieChart.md (72%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/PieData.md (68%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/PointData.md (68%) rename reference/sdk/javascript/code-interpreter/{messaging => }/type-aliases/RawData.md (64%) rename reference/sdk/javascript/code-interpreter/{sandbox => }/type-aliases/RunCodeLanguage.md (68%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/ScatterChart.md (66%) rename reference/sdk/javascript/code-interpreter/{charts => }/type-aliases/SuperChart.md (73%) create mode 100644 reference/sdk/javascript/commands/classes/CommandExitError.md create mode 100644 reference/sdk/javascript/commands/interfaces/CommandHandle.md create mode 100644 reference/sdk/javascript/commands/interfaces/CommandResult.md rename reference/sdk/javascript/commands/{classes => interfaces}/Commands.md (66%) rename reference/sdk/javascript/commands/{classes => interfaces}/Pty.md (79%) create mode 100644 reference/sdk/javascript/commands/type-aliases/PtyOutput.md create mode 100644 reference/sdk/javascript/commands/type-aliases/Stderr.md create mode 100644 reference/sdk/javascript/commands/type-aliases/Stdout.md delete mode 100644 reference/sdk/javascript/errors/functions/formatSandboxTimeoutError.md create mode 100644 reference/sdk/javascript/filesystem/enumerations/FilesystemEventType.md delete mode 100644 reference/sdk/javascript/filesystem/functions/mapEntryInfo.md rename reference/sdk/javascript/filesystem/{classes => interfaces}/Filesystem.md (70%) create mode 100644 reference/sdk/javascript/filesystem/interfaces/FilesystemEvent.md delete mode 100644 reference/sdk/javascript/filesystem/interfaces/FilesystemListOpts.md delete mode 100644 reference/sdk/javascript/filesystem/interfaces/FilesystemRequestOpts.md create mode 100644 reference/sdk/javascript/filesystem/interfaces/WatchHandle.md delete mode 100644 reference/sdk/javascript/filesystem/interfaces/WatchOpts.md delete mode 100644 reference/sdk/javascript/filesystem/type-aliases/WriteEntry.md create mode 100644 reference/sdk/javascript/logger/interfaces/Logger.md create mode 100644 reference/sdk/javascript/sandbox/classes/AgentBox.md rename reference/sdk/javascript/sandbox/{index => }/classes/Sandbox.md (77%) delete mode 100644 reference/sdk/javascript/sandbox/index/README.md delete mode 100644 reference/sdk/javascript/sandbox/index/interfaces/SandboxUrlOpts.md rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/CreateSnapshotOpts.md (96%) create mode 100644 reference/sdk/javascript/sandbox/interfaces/McpServer.md rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxApiOpts.md (96%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxForkOpts.md (97%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxIamOpts.md (87%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxIamToken.md (80%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxInfo.md (94%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxListOpts.md (96%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxMetrics.md (89%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxMetricsOpts.md (96%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxOpts.md (96%) rename reference/sdk/javascript/sandbox/{sandboxApi/classes => interfaces}/SandboxPaginator.md (71%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SandboxPauseOpts.md (96%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SnapshotInfo.md (85%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/interfaces/SnapshotListOpts.md (96%) rename reference/sdk/javascript/sandbox/{sandboxApi/classes => interfaces}/SnapshotPaginator.md (71%) delete mode 100644 reference/sdk/javascript/sandbox/sandboxApi/README.md delete mode 100644 reference/sdk/javascript/sandbox/sandboxApi/classes/SandboxApi.md delete mode 100644 reference/sdk/javascript/sandbox/sandboxApi/type-aliases/GitHubMcpServer.md delete mode 100644 reference/sdk/javascript/sandbox/sandboxApi/type-aliases/McpServer.md create mode 100644 reference/sdk/javascript/sandbox/type-aliases/AgentBoxClientOpts.md rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxConnectOpts.md (86%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxIamTokenType.md (75%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxInfoLifecycle.md (76%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxLifecycle.md (90%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkInfo.md (88%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkOpts.md (96%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkRule.md (89%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkRuleInfo.md (83%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkRules.md (85%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkSelector.md (75%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkSelectorContext.md (85%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkTransform.md (80%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkTransformContext.md (92%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkTransformResolver.md (83%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxNetworkUpdate.md (88%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxOnTimeout.md (95%) rename reference/sdk/javascript/sandbox/{sandboxApi => }/type-aliases/SandboxState.md (56%) diff --git a/reference-config/javascript/code-interpreter.ts b/reference-config/javascript/code-interpreter.ts new file mode 100644 index 00000000..8473f59c --- /dev/null +++ b/reference-config/javascript/code-interpreter.ts @@ -0,0 +1,28 @@ +export { Sandbox } from '../../packages/code-interpreter-js/src/index' +export type { + BarChart, + BarData, + BoxAndWhiskerChart, + BoxAndWhiskerData, + Chart, + ChartType, + ChartTypes, + Context, + CreateCodeContextOpts, + Execution, + ExecutionError, + LineChart, + Logs, + MIMEType, + OutputMessage, + PieChart, + PieData, + PointData, + RawData, + Result, + RunCodeLanguage, + RunCodeOpts, + ScaleType, + ScatterChart, + SuperChart, +} from '../../packages/code-interpreter-js/src/index' diff --git a/reference-config/javascript/commands.ts b/reference-config/javascript/commands.ts new file mode 100644 index 00000000..2e8eb3b7 --- /dev/null +++ b/reference-config/javascript/commands.ts @@ -0,0 +1,14 @@ +export { CommandExitError } from '../../packages/js-sdk/src/index' +export type { + CommandConnectOpts, + CommandHandle, + CommandRequestOpts, + CommandResult, + Commands, + CommandStartOpts, + ProcessInfo, + Pty, + PtyOutput, + Stderr, + Stdout, +} from '../../packages/js-sdk/src/index' diff --git a/reference-config/javascript/errors.ts b/reference-config/javascript/errors.ts new file mode 100644 index 00000000..868b6763 --- /dev/null +++ b/reference-config/javascript/errors.ts @@ -0,0 +1,13 @@ +export { + AuthenticationError, + BuildError, + FileNotFoundError, + FileUploadError, + InvalidArgumentError, + NotEnoughSpaceError, + RateLimitError, + SandboxError, + SandboxNotFoundError, + TemplateError, + TimeoutError, +} from '../../packages/js-sdk/src/index' diff --git a/reference-config/javascript/filesystem.ts b/reference-config/javascript/filesystem.ts new file mode 100644 index 00000000..4ea9483a --- /dev/null +++ b/reference-config/javascript/filesystem.ts @@ -0,0 +1,10 @@ +export { FilesystemEventType, FileType } from '../../packages/js-sdk/src/index' +export type { + EntryInfo, + Filesystem, + FilesystemEvent, + FilesystemReadOpts, + FilesystemWriteOpts, + WatchHandle, + WriteInfo, +} from '../../packages/js-sdk/src/index' diff --git a/reference-config/javascript/logger.ts b/reference-config/javascript/logger.ts new file mode 100644 index 00000000..b2193236 --- /dev/null +++ b/reference-config/javascript/logger.ts @@ -0,0 +1,7 @@ +export { + defaultBuildLogger, + LogEntry, + LogEntryEnd, + LogEntryStart, +} from '../../packages/js-sdk/src/index' +export type { LogEntryLevel, Logger } from '../../packages/js-sdk/src/index' diff --git a/reference-config/javascript/ready-commands.ts b/reference-config/javascript/ready-commands.ts new file mode 100644 index 00000000..7e74c4d7 --- /dev/null +++ b/reference-config/javascript/ready-commands.ts @@ -0,0 +1,8 @@ +export { + ReadyCmd, + waitForFile, + waitForPort, + waitForProcess, + waitForTimeout, + waitForURL, +} from '../../packages/js-sdk/src/index' diff --git a/reference-config/javascript/sandbox.ts b/reference-config/javascript/sandbox.ts new file mode 100644 index 00000000..0cabf963 --- /dev/null +++ b/reference-config/javascript/sandbox.ts @@ -0,0 +1,37 @@ +export { AgentBox, Sandbox } from '../../packages/js-sdk/src/index' +export type { + AgentBoxClientOpts, + CreateSnapshotOpts, + McpServer, + SandboxApiOpts, + SandboxConnectOpts, + SandboxForkOpts, + SandboxIamOpts, + SandboxIamToken, + SandboxIamTokenType, + SandboxInfo, + SandboxInfoLifecycle, + SandboxLifecycle, + SandboxListOpts, + SandboxMetrics, + SandboxMetricsOpts, + SandboxNetworkInfo, + SandboxNetworkOpts, + SandboxNetworkRule, + SandboxNetworkRuleInfo, + SandboxNetworkRules, + SandboxNetworkSelector, + SandboxNetworkSelectorContext, + SandboxNetworkTransform, + SandboxNetworkTransformContext, + SandboxNetworkTransformResolver, + SandboxNetworkUpdate, + SandboxOnTimeout, + SandboxOpts, + SandboxPauseOpts, + SandboxPaginator, + SandboxState, + SnapshotInfo, + SnapshotListOpts, + SnapshotPaginator, +} from '../../packages/js-sdk/src/index' diff --git a/reference-config/javascript/templates.ts b/reference-config/javascript/templates.ts new file mode 100644 index 00000000..87b534f6 --- /dev/null +++ b/reference-config/javascript/templates.ts @@ -0,0 +1,15 @@ +export { Template, TemplateBase } from '../../packages/js-sdk/src/index' +export type { + BuildInfo, + BuildOptions, + BuildStatusReason, + CopyItem, + GetBuildStatusOptions, + McpServerName, + TemplateBuilder, + TemplateBuildStatus, + TemplateBuildStatusResponse, + TemplateClass, + TemplateTag, + TemplateTagInfo, +} from '../../packages/js-sdk/src/index' diff --git a/reference-config/sdk-groups.json b/reference-config/sdk-groups.json index c138d1d2..b49c3c72 100644 --- a/reference-config/sdk-groups.json +++ b/reference-config/sdk-groups.json @@ -1,20 +1,37 @@ { "javascript": { - "errors": ["packages/js-sdk/src/errors.ts"], - "sandbox": [ - "packages/js-sdk/src/sandbox/index.ts", - "packages/js-sdk/src/sandbox/sandboxApi.ts" - ], - "commands": ["packages/js-sdk/src/sandbox/commands/index.ts"], - "filesystem": ["packages/js-sdk/src/sandbox/filesystem/index.ts"], - "templates": ["packages/js-sdk/src/template/index.ts"], - "logger": ["packages/js-sdk/src/template/logger.ts"], - "ready-commands": ["packages/js-sdk/src/template/readycmd.ts"], - "code-interpreter": [ - "packages/code-interpreter-js/src/sandbox.ts", - "packages/code-interpreter-js/src/messaging.ts", - "packages/code-interpreter-js/src/charts.ts" - ] + "errors": { + "entryPoint": "reference-config/javascript/errors.ts", + "tsconfig": "reference-config/typedoc.js-sdk.json" + }, + "sandbox": { + "entryPoint": "reference-config/javascript/sandbox.ts", + "tsconfig": "reference-config/typedoc.js-sdk.json" + }, + "commands": { + "entryPoint": "reference-config/javascript/commands.ts", + "tsconfig": "reference-config/typedoc.js-sdk.json" + }, + "filesystem": { + "entryPoint": "reference-config/javascript/filesystem.ts", + "tsconfig": "reference-config/typedoc.js-sdk.json" + }, + "templates": { + "entryPoint": "reference-config/javascript/templates.ts", + "tsconfig": "reference-config/typedoc.js-sdk.json" + }, + "logger": { + "entryPoint": "reference-config/javascript/logger.ts", + "tsconfig": "reference-config/typedoc.js-sdk.json" + }, + "ready-commands": { + "entryPoint": "reference-config/javascript/ready-commands.ts", + "tsconfig": "reference-config/typedoc.js-sdk.json" + }, + "code-interpreter": { + "entryPoint": "reference-config/javascript/code-interpreter.ts", + "tsconfig": "reference-config/typedoc.code-interpreter.json" + } }, "python": { "exceptions": ["agentbox.exceptions"], diff --git a/reference-config/typedoc.code-interpreter.json b/reference-config/typedoc.code-interpreter.json index 28215503..6fd18770 100644 --- a/reference-config/typedoc.code-interpreter.json +++ b/reference-config/typedoc.code-interpreter.json @@ -7,5 +7,9 @@ "paths": { "@abox-dev/sdk": ["packages/js-sdk/src/index.ts"] } - } + }, + "include": [ + "../packages/code-interpreter-js/src/**/*.ts", + "javascript/code-interpreter.ts" + ] } diff --git a/reference-config/typedoc.js-sdk.json b/reference-config/typedoc.js-sdk.json new file mode 100644 index 00000000..586d7bd1 --- /dev/null +++ b/reference-config/typedoc.js-sdk.json @@ -0,0 +1,9 @@ +{ + "extends": "../packages/js-sdk/tsconfig.json", + "compilerOptions": { + "baseUrl": "..", + "rootDir": "..", + "ignoreDeprecations": "6.0" + }, + "include": ["../packages/js-sdk/src/**/*.ts", "javascript/*.ts"] +} diff --git a/reference/manifest.json b/reference/manifest.json index 8afbbca3..448d0c35 100644 --- a/reference/manifest.json +++ b/reference/manifest.json @@ -4,143 +4,174 @@ "connect/process.md": "037574455e9e8c5159c391d8c007e7272560f62c4e5ee681f8aec29f9cd24539", "openapi/control-plane.yml": "f0a5b8c69f92bc19ed2bebb77d1fc097f991f8ecdd06cf439082eb73b64c93fe", "openapi/envd.yml": "e4d91017beb3885ef4b389ab23f30f43682ee6a2c01721275e6513d8cfe6217d", - "openapi/operations.json": "78801f197ba691e54d42c5b6026aa4112f883eeb1966595cc2529f895dc0852a", + "openapi/markdown/assignTemplateTags.md": "fa9f7b2fd59332151695fab853f7f29b253e8837bbd6d8fa669258a303622819", + "openapi/markdown/composeFiles.md": "c814b69b4721e1a8c1a4d202bfc38feccfd12576071a21af8d9380baf6c2ff28", + "openapi/markdown/connectSandbox.md": "d2acb99ec38360e5146f06a895f96bd6034a9cd8a56ff8acbd727cc8d1bb8fa5", + "openapi/markdown/createSandbox.md": "e17fc2aa20769eb0f4456aeaaf8e887af5faf3d4e9ed636e400bf08eaf401c17", + "openapi/markdown/createSnapshot.md": "b1aaf62afe3723c04fcd7c1f1b092a24a0342b28de2b680d6a9d0afc014ddc3b", + "openapi/markdown/createTemplate.md": "4a9604d8cb7af1cb8c0da6b7e3bd56cfb7a20a4c91463013e55850f9854ea06c", + "openapi/markdown/deleteTemplate.md": "31f4140050bb8753a0e8294f4b60425695866b2a3930a861ed1657ec4fb07029", + "openapi/markdown/deleteTemplateTags.md": "94e5f1831a4044ea6acb248326fba83d9c6f0123bd61a3b2c401426fcd434b82", + "openapi/markdown/downloadFile.md": "3cded9f4d62b95e4fbb6bc4d548340c5943538010b04bfba690bfb042cd0ae4d", + "openapi/markdown/forkSandbox.md": "e773314d8f074b168db204072097c2bff06fac52960d5a89db5172a980ab8668", + "openapi/markdown/getEnvironmentHealth.md": "640c9435ce216a6fd0e5da7ee646d8527e5de428c946fad219946f5c1de5622a", + "openapi/markdown/getEnvironmentMetrics.md": "32f7d61ddb8980caec0beaa3821b99e5f6ef90c0e812390d4d417844ec99acdc", + "openapi/markdown/getEnvironmentVariables.md": "12803bbc7e3f2638e16f013ce05b2a688d8085739e38049c1022452fd7881e50", + "openapi/markdown/getSandbox.md": "3cf849c2093a536b19858ec431162413cd8b5e66ae7fb344f83b881b331d15ca", + "openapi/markdown/getSandboxLogs.md": "d5e3adfca5ff72d3b04ad8f2f5bb038ce429d8d7381cc37db33c9b4f393df047", + "openapi/markdown/getSandboxMetrics.md": "cc810ac8bd47c0bf3903a2a529d5489af61611cb7268ef2327f93007d08d9467", + "openapi/markdown/getTeamMetrics.md": "8cdaab8e8e3f089793e75ce6e831ee4effec72acf4f9297644503e175fc25368", + "openapi/markdown/getTeamMetricsMax.md": "85ee15af0672e21484da2378da9ac0e5171d062eff30de3a70f2927056383ec0", + "openapi/markdown/getTemplate.md": "43e22cc700d0bdcc85206d59db06bc9bea47d57bc4d418ec7c353e4b404939cb", + "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": "740c58aa17455c219647713f1d3f9ea5bea7ea0aeff346436f8c1f1902c973d3", "sdk/cli/auth.md": "0b2c75262b0c0670c7bc0f0f3cbed65fbe4a16d6fe4437789a5685b8bf2174a1", "sdk/cli/sandbox.md": "0f59649197a6f42282a8b789c4384e8e41d2e525de414a22dffe073f0fca4d64", "sdk/cli/template.md": "f270b22b9ee10a9b954a14f24e04c5449b4d5823bb28002ffde3ed682594cfc5", - "sdk/javascript/code-interpreter/README.md": "039623531e5230593b947e9a1a21690cfbf0ae99d96bf1f28e855d3cde9bb4f8", - "sdk/javascript/code-interpreter/charts/README.md": "9ccf26a23701a8424a6603ccf62e9d11e6f94420856d91275d17e9f792f0bd1f", - "sdk/javascript/code-interpreter/charts/enumerations/ChartType.md": "c393d23dafe81aec247ce84270fdfee89aa31fc5d8b78b668a894b2bc9b1102b", - "sdk/javascript/code-interpreter/charts/enumerations/ScaleType.md": "9997e8c06d17e7f1f540c7ff3e8582fecdddc2c0b7192c465a49fcbb0649a1ac", - "sdk/javascript/code-interpreter/charts/functions/deserializeChart.md": "973ca2b42d0cc25c97435eed21e2e5a5622ffa8ef4d3c61f143dcad1427d02a9", - "sdk/javascript/code-interpreter/charts/type-aliases/BarChart.md": "87c25787fd08c5a398c821e922afc937a4dda8f47a7ebe4cde439969efabd8cd", - "sdk/javascript/code-interpreter/charts/type-aliases/BarData.md": "f9e5653a14e631e010cd0b8ec84b71af5c74ed2113513bdbb26f0b622ea80020", - "sdk/javascript/code-interpreter/charts/type-aliases/BoxAndWhiskerChart.md": "daeaffc6df025985c55303cfe37f074942e878463685a19af02440f786f98ba6", - "sdk/javascript/code-interpreter/charts/type-aliases/BoxAndWhiskerData.md": "5a03be5357a27e6964f22b4ca5bcc4780d80d18a564a4860401a83c70629af6b", - "sdk/javascript/code-interpreter/charts/type-aliases/Chart.md": "607fcd5c742952765d3651df25738812add74efc3aac955ae4bd7fc67a63976b", - "sdk/javascript/code-interpreter/charts/type-aliases/ChartTypes.md": "40252fe3c0af2c82b2b82735f5cb654bf3f6d04fd957ccf6788c9f0ae1ca5a02", - "sdk/javascript/code-interpreter/charts/type-aliases/LineChart.md": "07a1257762c47c47e14b6fc1d2889abfa34fc29a11cf2299d6c114912f458011", - "sdk/javascript/code-interpreter/charts/type-aliases/PieChart.md": "5f1458673413562ec8bb62da444e8a2bf2bf4f904c780316077fb8013c0c87d6", - "sdk/javascript/code-interpreter/charts/type-aliases/PieData.md": "37d400c47d192918c8d6d95d6cc5c4c4fd53f50d668ffb35d64f97375ecd9c78", - "sdk/javascript/code-interpreter/charts/type-aliases/PointData.md": "9f795ecc3a19b30c14d659451c89c4be6da023898c0dfffd925f464fc5aa7ef0", - "sdk/javascript/code-interpreter/charts/type-aliases/ScatterChart.md": "1f54d35203890751fe3a2c9bc550a727d980062351bef1e23451e4fd356866bb", - "sdk/javascript/code-interpreter/charts/type-aliases/SuperChart.md": "a2a98a221d1b4b090f152218e4f89ad75303b619db10a54c7a71d392918e23cf", - "sdk/javascript/code-interpreter/messaging/README.md": "bc0fb2eb6b33aece38ada22b433e96f3b40c1652536522656e6ced3935260dc7", - "sdk/javascript/code-interpreter/messaging/classes/Execution.md": "8582fb8dd0036eec1b66303b5ad71d33008bade55233ac9fb692f41bc7f5aac9", - "sdk/javascript/code-interpreter/messaging/classes/ExecutionError.md": "bba0cd11403a179297d6684ef2b328db743e3632e4f962ba013fb658f5546e8b", - "sdk/javascript/code-interpreter/messaging/classes/OutputMessage.md": "308fe78a3e9d8af7deca22fe9750599b83bf9d704c5e3b19bc6f00f1753462f0", - "sdk/javascript/code-interpreter/messaging/classes/Result.md": "88dc6a0fee61eb5c30f6db136e6416d55794619f6dd0f87e3d24672259e6abfe", - "sdk/javascript/code-interpreter/messaging/functions/extractError.md": "1a9e1cc0750542df81ad425335be805a640f3e32964f8b54da42b6e15da799be", - "sdk/javascript/code-interpreter/messaging/functions/parseOutput.md": "af4fe0c24923bb81f1da89223ff90d432d4249d1e184cffa0855f90585424bb2", - "sdk/javascript/code-interpreter/messaging/type-aliases/Logs.md": "b8abe4852b01003ea43dbc1578a5ebddf251130a0697400481057878008133de", - "sdk/javascript/code-interpreter/messaging/type-aliases/MIMEType.md": "e83e73d6a0e97763e7e82b736871be2363b73f078d500b0f753d0d5085a6737c", - "sdk/javascript/code-interpreter/messaging/type-aliases/RawData.md": "1d4c93b749bebbb87e1f2b4a335528adb16f98360a24550c1fbb4d2056ca3c9b", - "sdk/javascript/code-interpreter/sandbox/README.md": "ce7ff81b5b0bc706ab215ebbb971aac7951fbcd82959c0884fff8c84f0aae33a", - "sdk/javascript/code-interpreter/sandbox/classes/Sandbox.md": "953be987b9939a4d498e04e2c9d9e8bd6fe3312ca7aa33add9a2cf8b0537a176", - "sdk/javascript/code-interpreter/sandbox/interfaces/CreateCodeContextOpts.md": "9077fc89c2bc9589e19112b63158ad55cd4d75c52879af93d3b65dd391fc1eaf", - "sdk/javascript/code-interpreter/sandbox/interfaces/RunCodeOpts.md": "b7518d5d91a0def0d7f2f10bb4153a76969f0c0c049cac930519342d93c64556", - "sdk/javascript/code-interpreter/sandbox/type-aliases/Context.md": "01a1570ac3f1870cb303215203b7b3dddf26bfcf5cc53c863bb65ea493956825", - "sdk/javascript/code-interpreter/sandbox/type-aliases/RunCodeLanguage.md": "636454bcc7c0bbf51dfc12cc2ed6cb9cf844178929d3a4a6614276998cac5cc6", - "sdk/javascript/commands/README.md": "dabba5d624e6788045c622fa73d9197a22802ae8a2e6a7c892750210bca5bc11", - "sdk/javascript/commands/classes/Commands.md": "2b5da52e1e5b13a132a5f32a0b1fa70dd185b1c86faaedc5e758ed9b02431998", - "sdk/javascript/commands/classes/Pty.md": "50fe1486af6f004c3112309561fce7c2b8831ad8ddbfa8d163399f1db6bf366d", - "sdk/javascript/commands/interfaces/CommandRequestOpts.md": "df8e606a14ec23ea086f9c966ebebc46fa62f0158881b1266bb245a299202f34", - "sdk/javascript/commands/interfaces/CommandStartOpts.md": "fe944bc69cefad940990aaa52a7e195cef0fe986a0c31671221beea810a0a95c", - "sdk/javascript/commands/interfaces/ProcessInfo.md": "092cf569bf5fc6a785af445d9bf98fda3072e3776d22be5dbe97068b8b1e6d1b", - "sdk/javascript/commands/type-aliases/CommandConnectOpts.md": "474af2675eebc52a8fec3695f801d289337550fb06c323e45939dc6e98b43d3c", - "sdk/javascript/errors/README.md": "1ffc232147a41878ce032004326cf05e8fe7ca5b0dda890dc5217abef2fd9c85", - "sdk/javascript/errors/classes/AuthenticationError.md": "2680ac56bc87242c69d04b9148df55b2c1904135cf1e12be096560b5cbd59e22", - "sdk/javascript/errors/classes/BuildError.md": "2825b775a0c5731e9da8bd0bc463a3b0bfd01fa7aa5216e998f3c604a5d3c110", - "sdk/javascript/errors/classes/FileNotFoundError.md": "c413c9590d29b9fc382edc9bee1868471d86e9fdd7afceb7567aa6ba42e3435f", - "sdk/javascript/errors/classes/FileUploadError.md": "ce7070ac8013c4414340cbc6c917e24d05df732a3bbf72a4d7e8ac13cdd8affc", - "sdk/javascript/errors/classes/InvalidArgumentError.md": "032683cf008b05d24b62505e11cf48b8711b847b979bc20684328ee36f44bd68", - "sdk/javascript/errors/classes/NotEnoughSpaceError.md": "5d8026af48a12af101eb06d566cdb21dd23f9596a1943f50fe822bd119bc1ae3", - "sdk/javascript/errors/classes/RateLimitError.md": "5ee27148668630dbe20618cee2ef354a6337bcba3a8dbb042401d07bc0a22134", - "sdk/javascript/errors/classes/SandboxError.md": "fc706640efa003909b83d9242ae22ee6cd13de1ac7b8532cc8a063818c5e2a86", - "sdk/javascript/errors/classes/SandboxNotFoundError.md": "c5c86e302c5506fd4ed6effed1aee7f098fd95eac1105bab2e155fd804067ad4", - "sdk/javascript/errors/classes/TemplateError.md": "e308051d546329e1fdace73b5ef1bd88a811e301a68427d63e5fc3811ae31b25", - "sdk/javascript/errors/classes/TimeoutError.md": "2bf1a25743de8d27691213dc0bac79672227e41b44093499bd61d41b9c88bb1b", - "sdk/javascript/errors/functions/formatSandboxTimeoutError.md": "b988774343843655642def8a803258d0d46a297bd03bdbbd0d16259f6b610ea3", - "sdk/javascript/filesystem/README.md": "37effe2c50d20b4bdfd2b460bfa0418537a91744e71829e2ac996353d035801e", - "sdk/javascript/filesystem/classes/Filesystem.md": "3a82812bde29265b39ab29669795b6430247ad4cf630402d6755445622bf5193", - "sdk/javascript/filesystem/enumerations/FileType.md": "00df1e000a8f60644b75ad13765e35583c84a9e754f86d27446d271ffc757c70", - "sdk/javascript/filesystem/functions/mapEntryInfo.md": "84698ca0bdae9f442ede963d23c7bba5b8e91240ca71eb0c45fa7305825058ec", - "sdk/javascript/filesystem/interfaces/EntryInfo.md": "1d692b3fc4e6067ef8467246ec28b1a5e3297e4434cbc77b2e9bbb1c1afdd42e", - "sdk/javascript/filesystem/interfaces/FilesystemListOpts.md": "94f455099c31281a1c2244e5bcb97aaf6f32d22c17d37c314ffcefe44bd39a24", - "sdk/javascript/filesystem/interfaces/FilesystemReadOpts.md": "5677fdd1dc04db871462c0dc81180534f2eb0f0cc87a338fa39c75ef330f813b", - "sdk/javascript/filesystem/interfaces/FilesystemRequestOpts.md": "a2f8a0f1fceb25bdbb6633c1ebc8075d08ed44eb6020dfe8df56672e50485523", - "sdk/javascript/filesystem/interfaces/FilesystemWriteOpts.md": "679126fc65ff20e8dd9da8b4ec58b1bbc92be57db8c84c16ac0cba3cdff01f2f", - "sdk/javascript/filesystem/interfaces/WatchOpts.md": "4ec34e5f94f48f18342fd68dc7c6be028f0290ad2a266042c89a009470ea397b", - "sdk/javascript/filesystem/interfaces/WriteInfo.md": "83ceaaf70c4811125a7359bffef0f2b73616fe43681678f47bfa4a5cd3178861", - "sdk/javascript/filesystem/type-aliases/WriteEntry.md": "e0741a7f7b3c075d6ce4076b563cd1fa21c2defffe071703554ae3ac05e1bf0c", - "sdk/javascript/logger/README.md": "eef3e06788b317326c987ba9a40cb3f267fb55166dd6bdb0debbd0489c884c34", - "sdk/javascript/logger/classes/LogEntry.md": "631fd72818a8ae1f64ae1f337bd5f1f23e0e24fbf3515ecc30c023727874e357", - "sdk/javascript/logger/classes/LogEntryEnd.md": "eeda5c8cecc0644ea0b73cc1ac7e1345af62eec4ea0857ef8b40913326c470bc", - "sdk/javascript/logger/classes/LogEntryStart.md": "2f1ed14ea1e19287c00dfb028139fc4dc6dd67aadac235d1e1bfff5069bf98f7", - "sdk/javascript/logger/functions/defaultBuildLogger.md": "f8dc7e3a5d766f29c0202315bb7f05a95edc802d69ef2c6876abaacf2cb9cfe4", - "sdk/javascript/logger/type-aliases/LogEntryLevel.md": "a0286486a7bd1574c1e2238d0ca59bc9436303fe8b0d12bcbef8f7a207333cc0", - "sdk/javascript/ready-commands/README.md": "0d3f38c75323a366a915f6603014d0aa77618f1ed519bfa4685a75d87cf112fd", - "sdk/javascript/ready-commands/classes/ReadyCmd.md": "2946b0f847c6bc61670a655997cd9c1b7c3de365093657bcbaeb9cc3cb4cfd39", - "sdk/javascript/ready-commands/functions/waitForFile.md": "9c2f4b23c318f6bdbba4df678679ef41ce386ede374bbcd180c9b7942c297660", - "sdk/javascript/ready-commands/functions/waitForPort.md": "304c45757a7449748b18c056ba44daf318306ae6ac550a08ff297a2544503f57", - "sdk/javascript/ready-commands/functions/waitForProcess.md": "036288a363552520a527e152257e732ffbe32f209b0590c4cee12a60fcf7a970", - "sdk/javascript/ready-commands/functions/waitForTimeout.md": "26cb10fe7070b972ce1210e7f931ed32783c9edaeb2e3a31a9d1f30fffef470c", - "sdk/javascript/ready-commands/functions/waitForURL.md": "08bab702f4c333d5132cda05ba810c3262cb6bf01c9cddd0287abb2774940dc3", - "sdk/javascript/sandbox/README.md": "2c010fbaf61ec94a24067d30650db155e9bb92f5b5760cd255479c82019b0b81", - "sdk/javascript/sandbox/index/README.md": "d3d3842b2e46af321942d5bdf6fc2c75f3a6d474f2a8d3f7b7787b993acb8867", - "sdk/javascript/sandbox/index/classes/Sandbox.md": "831abee3f504380c7abb47e4cdd1e09f29173fbd960f320bd4603505827ad419", - "sdk/javascript/sandbox/index/interfaces/SandboxUrlOpts.md": "4e5afdc62b343bdfc89fc96478143ccf013d6f670253330a10042fa8775fe929", - "sdk/javascript/sandbox/sandboxApi/README.md": "c22958d25bc3cb59806d04ae768c02cc924845a10dc2cb9252cde643a2c1a24b", - "sdk/javascript/sandbox/sandboxApi/classes/SandboxApi.md": "34425d9542b006633d1c08af181bc2e3db7d21daaeca4c9452787a936f0e60e5", - "sdk/javascript/sandbox/sandboxApi/classes/SandboxPaginator.md": "296b8de58eb6e5871fcd2e273ee6f38638d2597fbff4a5f83ef5d79e2af456c8", - "sdk/javascript/sandbox/sandboxApi/classes/SnapshotPaginator.md": "3ffcb8d44a315f6f8ca2a63a58dff76933ea4f247871df5e8e1fa87a998edc4d", - "sdk/javascript/sandbox/sandboxApi/interfaces/CreateSnapshotOpts.md": "bd1256b70decc641f7f013c47d15a703c133a0656f83fedde3b7074f0cec472d", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxApiOpts.md": "28feeda0fe8484b19aeacdee3b08a34f8ced22bd929e00587e75ce0fc4ee5aba", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxForkOpts.md": "8084497f7cdfd120f8cad96e9ae3b0296fe985f39d7d74853d90f6f8be7262be", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxIamOpts.md": "3e94acde665c2a71a021593caadf11558723af1d6c5f49ce5568e9449197fcc0", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxIamToken.md": "c693c4478553e55f715f46518269da1b6ae2ab020cd6e639bdf20a57f3a6a37c", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxInfo.md": "51b792dc91c00c0f5ecb16677491c1f3dcc34b2e30cc1f7af433c051af1216ed", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxListOpts.md": "bf804e2ea39d835cba20e8c00636f2e466ad294c1630a3eb9262500fb14e4462", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxMetrics.md": "6a106c608cb3342ea41b708ec2d841b432bd4ce4ffb003037a1bb9facaea4ddb", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxMetricsOpts.md": "95a90db4c36b86e2d855965849dbba6d1b5e2b1cccb916fbb168464e657ac954", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxOpts.md": "0735fd0cc646b1a46ded791d36f6e73e0a68d2b7a038ca57ea147bc5c2c0ed56", - "sdk/javascript/sandbox/sandboxApi/interfaces/SandboxPauseOpts.md": "db3f46dc7f9653aa0165ee85a92de5d97d30f4f2fec9e7034cdeb6d625e3ce7c", - "sdk/javascript/sandbox/sandboxApi/interfaces/SnapshotInfo.md": "84ef8016ef145ec1875e2479574bc48487856cd0a933835d7b11265dc8ea2776", - "sdk/javascript/sandbox/sandboxApi/interfaces/SnapshotListOpts.md": "de16d942da289c61f41d39f39d7874cef2878852388049947184e6d79115f481", - "sdk/javascript/sandbox/sandboxApi/type-aliases/GitHubMcpServer.md": "543bc45cd5775ce52e2f199f4c8b6b5e0cad9b85f88d70bd36f61411f60cf873", - "sdk/javascript/sandbox/sandboxApi/type-aliases/McpServer.md": "af908c010089b8663f76520041771792e56ded927c94a7944b18fcdd86de2306", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxConnectOpts.md": "26b3e3bb550e86c143cc5540fa51d7b353ab1d44968f10f5767f069c89e3364b", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxIamTokenType.md": "1f5a4c23b63209e303d8937d24c99b6efcc9ab9d2bc411d657d39259e1e7cd3f", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxInfoLifecycle.md": "ae4807422fb962da0ca5f6ade53bfe79b9bf10ec85bbfe726076d640fbe492f3", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxLifecycle.md": "14702520802cbbe4182a7bd76fd1be0f624533cc2c7a3a189bb71cffbc10edd7", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkInfo.md": "af64327aa8900abe9aa9d421d85ee8f7cc989b99437100e4615a37657bd389e5", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkOpts.md": "7a45898ae2d7a6f78ddea277fc0412fe2f932cad41da88517440a4604399d73c", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkRule.md": "1f1ed032d7a0f40d26d33977d7ef5cb96ff3b9a0aae055113c160eb1242f7741", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkRuleInfo.md": "ce78abbe3c851bcbd34d83bb73f3d322d8ac10be17b334452b8e7f08019852f4", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkRules.md": "29424e7c6f63b6c731a1a4e37c9d1db1569fc548e0b22ee3bc4c3cb143f738fc", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkSelector.md": "5e24a00dd86239d9601af780822004212e8e0671cf9ed1dc5c6d9bbf37a53a4e", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkSelectorContext.md": "56db302979385122e05233fc3e9d67231e67415b3f31d09972d03b8d513f96df", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkTransform.md": "e50309d3e0753dc12d06369a469c845481deb4db701635e8f9682eb829410343", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkTransformContext.md": "42cdc1dcd0c8880dc0449a1cb2d37cfb4778217b8c340182790ab0bbe87459e4", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkTransformResolver.md": "f0a75157d8cb7dee305a9caf58bac1d3717ff2ce44ed1f6d1ff79b0c7f7922e1", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxNetworkUpdate.md": "9a2b030bd4203906f38ba85c82978575f9e110e0816d3b56fafaf39e311747ff", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxOnTimeout.md": "a585ebbb7daf376e3486198841598b30040b816bf88b596b9ea765f00f2e0683", - "sdk/javascript/sandbox/sandboxApi/type-aliases/SandboxState.md": "1489273567a77a83cc8a91389f5ce3ca088cb2ba289c2a11c442bdbfb07d7e27", - "sdk/javascript/templates/README.md": "2f1eb594c20f28fabf010749911d9fafd4b5b815dc59b3d400b75f346e1bf2f6", - "sdk/javascript/templates/classes/TemplateBase.md": "1d3a5dc108b747952bf4b20789521ae2b074e4cbcc0f339457fa502fe6788c2c", - "sdk/javascript/templates/interfaces/TemplateBuilder.md": "b19bc17ce1f968a492d9211802aacd3ead94552a46d1c313394d392826b0988b", - "sdk/javascript/templates/type-aliases/BuildInfo.md": "a15fd36415ea4efe21ec9cada3e72048b33529cada0fec41690ac12b5b06defe", - "sdk/javascript/templates/type-aliases/BuildOptions.md": "1f794dba0649a3b6b9964e70c1beadc29be6bbea0ed4cbaf0929d93dba9fb754", - "sdk/javascript/templates/type-aliases/BuildStatusReason.md": "c1a51ea8f9f5950a291b372bf939b8f271c280f2810f02813e88f625acac91cc", - "sdk/javascript/templates/type-aliases/CopyItem.md": "d71df73a594e4cb03fa222f0ee521e48307d5aa9a584fbbe0afe1b5eb1103f92", - "sdk/javascript/templates/type-aliases/GetBuildStatusOptions.md": "e72dc7271670924d0f2b1f3587c875218885cf571504a319fef3ccd8c74b7fc8", - "sdk/javascript/templates/type-aliases/McpServerName.md": "5f7c676e7a0240cd630c8d692f520d8d8e7f1c801f895c32f963be8243955c8f", - "sdk/javascript/templates/type-aliases/TemplateBuildStatus.md": "ef893242c02a3dcc0ea92b1c852d04e67e24da1d3442ccd1aa287b02d9e845fc", - "sdk/javascript/templates/type-aliases/TemplateBuildStatusResponse.md": "c049cdb468c647ab4cfcf5f0b728a12f38e1fe1e177778ea701b67cb3ca51a65", - "sdk/javascript/templates/type-aliases/TemplateClass.md": "28ca1c5a025e17d54b69d61ee69f52ecf205e68501f0089352e917805f585581", - "sdk/javascript/templates/type-aliases/TemplateTag.md": "74162c518610fa858fc7a5afd235413c5ffe4e5ca627de0f26016025b6c600a4", - "sdk/javascript/templates/type-aliases/TemplateTagInfo.md": "981a48f86db51afdf465b8f00f63cb21771bd6f227f9543d3120c3a57d6eb3f5", - "sdk/javascript/templates/variables/Template.md": "b637efaa6ec0ecc231302ecbbac8472a718415e4f5e2697f38a33ccf2d8e2553", + "sdk/javascript/code-interpreter/README.md": "a787206eb86f81fc306b373ce20bc6c91464b0ab3c3ec7650eccbb6be5f676c5", + "sdk/javascript/code-interpreter/classes/Sandbox.md": "0c380df735431ad98397ec32920159e4c6ba103e600603551ded77b2f472839a", + "sdk/javascript/code-interpreter/enumerations/ChartType.md": "cf1ba00cd3258cc88814b7215e101b0d775ceb15dd833636d58ae538d8107ec1", + "sdk/javascript/code-interpreter/enumerations/ScaleType.md": "8cf4764b2c7844578b492dc0126d4ca13bb11d3c93accb28369ea24b3be8c0a1", + "sdk/javascript/code-interpreter/interfaces/CreateCodeContextOpts.md": "dccfd965ed1aaac775e2202db7779526ae5227b17757ab5e69933e7e900140ae", + "sdk/javascript/code-interpreter/interfaces/Execution.md": "9cb8c45af36ba4e0615c0e83ffc6650c7dfb627bc4c40d7caa580a469f7bbe4d", + "sdk/javascript/code-interpreter/interfaces/ExecutionError.md": "9cfe06c003ba6c3882ebdf2a0a6ad875e97daa773ee45b334100debe7794f331", + "sdk/javascript/code-interpreter/interfaces/OutputMessage.md": "95602814bd838db8aadd5833ed6f0ac68f5568caf4f639e1b16c3596b210287c", + "sdk/javascript/code-interpreter/interfaces/Result.md": "77dd73d27b4fc4421e114f3d43e0775857e98e3743571ec25a1c25250d2c1ba0", + "sdk/javascript/code-interpreter/interfaces/RunCodeOpts.md": "344ae47ee801de7a18c94fd4f4358473cea9ce71543e5ef36c6825b107966e94", + "sdk/javascript/code-interpreter/type-aliases/BarChart.md": "08ed9f9e77c21d87c1583acc09199be0b21500c9c0f77a1a448a7ccc525f88d9", + "sdk/javascript/code-interpreter/type-aliases/BarData.md": "d21d0e62fc4d3b153d33ade382ed878b54a8206fa01de54635a77436426a48c0", + "sdk/javascript/code-interpreter/type-aliases/BoxAndWhiskerChart.md": "066872a344326f461d5c3df0256426fb693c084f16441e9f975415ca46e9e9a2", + "sdk/javascript/code-interpreter/type-aliases/BoxAndWhiskerData.md": "05e0ba21d8c8cb87c6f99808d3d5edb4c562d8e55978906568753f15b742cfbe", + "sdk/javascript/code-interpreter/type-aliases/Chart.md": "da6ce44e5e8a22200ec721563a497c97cf3b0e1c8a558877b63f422adaded1cb", + "sdk/javascript/code-interpreter/type-aliases/ChartTypes.md": "9e99daa6fb52ae8b7184ce357b3861a6157121f7146ac11f31770e61879036f0", + "sdk/javascript/code-interpreter/type-aliases/Context.md": "bce00229b3a60799e305be47b83d42eae0e62eac46692b8b8788952c7e9b1149", + "sdk/javascript/code-interpreter/type-aliases/LineChart.md": "7d58a3379fa00fbbe8dd901d5fb109b1e07974ddfc6bed4c58da2e7289c7f335", + "sdk/javascript/code-interpreter/type-aliases/Logs.md": "1ff46861f0853f39ee85672e7a2e6fd6a84e6f81ea3e60f451d33538dbef97bd", + "sdk/javascript/code-interpreter/type-aliases/MIMEType.md": "a6329bf10c65fcfc831f4c441608aaae10cbeffdf2a6ca29c4b5ed87906086cb", + "sdk/javascript/code-interpreter/type-aliases/PieChart.md": "523339d0ca29144bdb595230f407f1b0fe702248b939fe42f29b9281da1acfb7", + "sdk/javascript/code-interpreter/type-aliases/PieData.md": "ca2f6e2d8fe4709b352cebc92e8bfd121baf58bd6f432ca8de2c2040291d0d26", + "sdk/javascript/code-interpreter/type-aliases/PointData.md": "68dba36eb40fffc8d2fb6791a6437ab310429ff5a2da0034501428472e72ddb5", + "sdk/javascript/code-interpreter/type-aliases/RawData.md": "a217d0d3935b329edb25e987691d4baf7a68bd459004442cab2d766101128f82", + "sdk/javascript/code-interpreter/type-aliases/RunCodeLanguage.md": "e2eda10fc5e6eba8889d769fb51841d4376484d3b568daa30f02f44f4d120a20", + "sdk/javascript/code-interpreter/type-aliases/ScatterChart.md": "393770f1273b4f330397bd25140524a88d9fb6cb74cb0ca0d782650d044e963d", + "sdk/javascript/code-interpreter/type-aliases/SuperChart.md": "e26273549c89eefd709507af667039facc4d1fe5c9cc529fd2b7defa806f71fc", + "sdk/javascript/commands/README.md": "836a2a0843a4f594416777ab1a6371224ad630a3c29f05183dc64e0f2ef0cbff", + "sdk/javascript/commands/classes/CommandExitError.md": "0cafcde9560261ba72f93bc69cb8939b2df5e4212e657ef037030bd9dee00936", + "sdk/javascript/commands/interfaces/CommandHandle.md": "cdce27be118fda49b0eea50f4696e9f6242bd69421ffb4a73874c15adf8c1252", + "sdk/javascript/commands/interfaces/CommandRequestOpts.md": "cafa91c729e7844793dc968f0c253e64f1f6c5b311e41e11b09f9ecb08e2e88b", + "sdk/javascript/commands/interfaces/CommandResult.md": "eab8e374efe1042d89052d6535ec148f0fa45b7a42056bbf1f5f37d350910cab", + "sdk/javascript/commands/interfaces/CommandStartOpts.md": "94b6b7b977696e8b013d09f545ccac254e46fd6b5ec2001ed5064579afdcc57e", + "sdk/javascript/commands/interfaces/Commands.md": "782a83ddcef47090d0d5dd5b237340c88c664730c3d58b12f79ba0027ca2bdbf", + "sdk/javascript/commands/interfaces/ProcessInfo.md": "f3b3be4d6a94eb18df59ed226e689175e62d92cc4c708013f73799e63985319c", + "sdk/javascript/commands/interfaces/Pty.md": "85962c5e714c73d23c38e64ee4936ecc945243d6c77f5fa6d9d790a2aaef56d8", + "sdk/javascript/commands/type-aliases/CommandConnectOpts.md": "831b9eaee3a26e90a5d7f9003a66ce334a4ef650928846428b54d0309efa0893", + "sdk/javascript/commands/type-aliases/PtyOutput.md": "bfd9a341150ed358bf7ce8e94aaea30d3b3afcf5974262e78112b1cd959a6d2a", + "sdk/javascript/commands/type-aliases/Stderr.md": "e9f4f9cf70ec20e2b61a9e4509a3a8969556b0ad1a17d61c6ac7d7e7e00793fd", + "sdk/javascript/commands/type-aliases/Stdout.md": "7e9b82848962f16a596287915ac54187023f87fc3cbcc5a1998a7aaaf4038b70", + "sdk/javascript/errors/README.md": "640f3708d83ec06bd9db78b421c5b8fd66fa09be5f89d945f75dc1ac3415edcc", + "sdk/javascript/errors/classes/AuthenticationError.md": "4ec1e51898e7f7d6c3a366a9949c1cde62fa8c322328d841e265edcf3661d106", + "sdk/javascript/errors/classes/BuildError.md": "02a3b265a03b035ac1b0c7026f2f4432a7ac2fd9650cb9207ca965bb7a0b70a6", + "sdk/javascript/errors/classes/FileNotFoundError.md": "c34da4d4c47d0a97bd5c57aa1f832fc4dc25832ba3dffb9024d7b6b25a83d1be", + "sdk/javascript/errors/classes/FileUploadError.md": "f0429c4aa8fbc71028c17c35eaa32b125b2ab0ed66bd07e3fc69c54461982279", + "sdk/javascript/errors/classes/InvalidArgumentError.md": "2912cbd9288e32172416a018f6e0b8151dabaead9fdd25508604d6ca7a46083a", + "sdk/javascript/errors/classes/NotEnoughSpaceError.md": "158fc473c131bd144287f09eca6ee4185e4889518a51b4afec14348f199bb930", + "sdk/javascript/errors/classes/RateLimitError.md": "d267a303c41b045cfed9294cc57a8811c2c5a4a23ce1f11907797998f036eac9", + "sdk/javascript/errors/classes/SandboxError.md": "f9ba82182638d3f446f8af283ad336aca121bbfa95a63add933b2f25e34bd946", + "sdk/javascript/errors/classes/SandboxNotFoundError.md": "97043859ea96d8a9036060a9e83c974b7609aff95cf9b94f290534a60f493e9b", + "sdk/javascript/errors/classes/TemplateError.md": "5e6aa02a96a73329edbc54615e389a722db93cf4017c266093932befe8d400d5", + "sdk/javascript/errors/classes/TimeoutError.md": "cc752f4bc03a682e101d17e13e4ed48e0405b95febc2e09bee7672bfc905401d", + "sdk/javascript/filesystem/README.md": "4651806fd974b4b4e02cf9ddf58f6b7152885648baba4312f499038f936c6300", + "sdk/javascript/filesystem/enumerations/FileType.md": "cf2b82751e95d53f85789f60c1170b69e92b368a59f3ba34ca342ca57fc8d6a9", + "sdk/javascript/filesystem/enumerations/FilesystemEventType.md": "2412fdc02e5b7238df27577d36ff76aaf12a09ee90d7154d7e06d51d6f63b97f", + "sdk/javascript/filesystem/interfaces/EntryInfo.md": "979955d3e109a326df3066db2bb560e2aefffebdfa547681ee9852e1327784c3", + "sdk/javascript/filesystem/interfaces/Filesystem.md": "a10cc91afc4be8f0f6c5bf2c2578675aed1ec6cd2d3c4db057e01690d0699077", + "sdk/javascript/filesystem/interfaces/FilesystemEvent.md": "52fcdf3d98e03c61b4d3e73347933daf14e3835584d652072516261fe5bcc3d8", + "sdk/javascript/filesystem/interfaces/FilesystemReadOpts.md": "e5cb1b4e1d02f4660bcf1b6a23080bf2042f34d10d8db12db07ebb0c42b2248d", + "sdk/javascript/filesystem/interfaces/FilesystemWriteOpts.md": "0f07bfa5ca5ecaa888b4c7b1f497e2b920ae427d5516771cd2a6ab2f80dd2072", + "sdk/javascript/filesystem/interfaces/WatchHandle.md": "f1954fe43e4fbd70d80402646821861da6402e09a87788dcdabba57f5773c3ca", + "sdk/javascript/filesystem/interfaces/WriteInfo.md": "e7f8386aa0e28b21011bceb1ee67e6c379fd7c11f59d88079b173d3489ecc81b", + "sdk/javascript/logger/README.md": "e975c5848a4f0d3b4859edb3fcc79e0579d1f37c848d856b3bf420152d974726", + "sdk/javascript/logger/classes/LogEntry.md": "681d630d4dc2cc6b4955c86e652352f9fc5b64b102974edf08160a584ab0df82", + "sdk/javascript/logger/classes/LogEntryEnd.md": "81f4d9405cd503cf558969ed7b6e1944e4ec58ae3de78b99ed4e3c962cd23b7b", + "sdk/javascript/logger/classes/LogEntryStart.md": "ab44fe1336790ac3bbca79b4735f57be1bdce8235bb765f4bf7de34c02896e67", + "sdk/javascript/logger/functions/defaultBuildLogger.md": "a06ef6920d1d48829dc338f236da2d990cbc2ba5fde07b38c66ffeddadccf504", + "sdk/javascript/logger/interfaces/Logger.md": "eb104501e9e597ad96058c452ac2949d59038f7ba2bb946646435b5377b4e821", + "sdk/javascript/logger/type-aliases/LogEntryLevel.md": "1ca1ab2cd69e8160f7aefd4d8eca53da3d4ca31d9a85774fb7d4fe1feaf04a48", + "sdk/javascript/ready-commands/README.md": "cbbacc0a4eabbd7134a733e6cefe19d91f8856ad060da4b990c98b785968d3d5", + "sdk/javascript/ready-commands/classes/ReadyCmd.md": "d3fe2cdde2ed1e273f84730cc2ead830148c71e4c85ad48a76a93cd6707fe9ec", + "sdk/javascript/ready-commands/functions/waitForFile.md": "20b3a370b3f07eabaee97a0df9975d6fbf0f13122eb02688f7a43d4a41a0db8c", + "sdk/javascript/ready-commands/functions/waitForPort.md": "fbc151cbf9f1a0593d3b4ba2b779154c31d4d70c0effb8c5ec6c3269b95b6d49", + "sdk/javascript/ready-commands/functions/waitForProcess.md": "c0cea131b510b0ab0d95fee51aa0cb4d4cf04a8b73b44e75ed997c201b084fae", + "sdk/javascript/ready-commands/functions/waitForTimeout.md": "c49a4cd845c5dc02d1ec630f7e496f6ee28b2fe41d43fbae2fa1c43bd4bab653", + "sdk/javascript/ready-commands/functions/waitForURL.md": "6d48c23ab42a46435af442d89652554b3972146db19f125ff77c7b03e91b744f", + "sdk/javascript/sandbox/README.md": "4835e9b776ae1006374372fdb374e29a3dd46380b610f374f2d88c3e9f495780", + "sdk/javascript/sandbox/classes/AgentBox.md": "eda95be473aab89d16d341ec9accf1d9afcae8b28c9cf3bb0783ef22241f0354", + "sdk/javascript/sandbox/classes/Sandbox.md": "3d3a29fb8c861829b0ceede40264ef1a1da8ba94134c6e13e3e4b740d7d11e03", + "sdk/javascript/sandbox/interfaces/CreateSnapshotOpts.md": "31969a24a0233a15b29dd5a4a3455d1afa7898c7db8b121ab00889df3b014dc7", + "sdk/javascript/sandbox/interfaces/McpServer.md": "80c715da37c6508052faed9f6c1ff5c96c92ddcf75dd1855dbf3e98b4217565d", + "sdk/javascript/sandbox/interfaces/SandboxApiOpts.md": "7d848b9c877ffb64855be04a5dcd3e3272186b69bb8d451bd7e37c2c69ae2647", + "sdk/javascript/sandbox/interfaces/SandboxForkOpts.md": "2b7f29dc36c0776fff31ca30bae8dd2da7c26e15e9956993cbf358b439b8d6de", + "sdk/javascript/sandbox/interfaces/SandboxIamOpts.md": "b0676dff6384475115b24f890d576020db5437b2539b1d1b34da8991ad85a3da", + "sdk/javascript/sandbox/interfaces/SandboxIamToken.md": "8824bf3a069f681e39de27443c097595b3214111b0df3e10be613ee380841119", + "sdk/javascript/sandbox/interfaces/SandboxInfo.md": "6512df3dc84cd5cf25122b2238f11c7391ac137faa8ae0cbd353e8d5d14da7b1", + "sdk/javascript/sandbox/interfaces/SandboxListOpts.md": "486f810b0127d72ab47928c487e9d73c9ad60dc41fd48539cfad0edd79edae07", + "sdk/javascript/sandbox/interfaces/SandboxMetrics.md": "4e7b66fee2d60e552c193956efca47cb16fa4696800e0434209517099f83852b", + "sdk/javascript/sandbox/interfaces/SandboxMetricsOpts.md": "dbdf9c20c43aa1cfc608e32eb750cb010c637216616456a4109e0e4bbf6f3392", + "sdk/javascript/sandbox/interfaces/SandboxOpts.md": "5f948d29a09cf6a0a9adc92c51a4713ed3ca74edb2c63d8c91ad7891f12c7d1d", + "sdk/javascript/sandbox/interfaces/SandboxPaginator.md": "31e1b349de4638b1eada4a0dd23c3e0f7dbaca6d405b2ff29d00967950e08dba", + "sdk/javascript/sandbox/interfaces/SandboxPauseOpts.md": "6759c87eedd7cb2333636aa8f7c05844aae8a14deb8f82e336aa6b4086e5e4f8", + "sdk/javascript/sandbox/interfaces/SnapshotInfo.md": "d54e8ee99f1fb9e1d43372b35ce42927cd33e9e21086d69f25e2ae1c6b9ec8c3", + "sdk/javascript/sandbox/interfaces/SnapshotListOpts.md": "631e3cf2bc3e9d402f8df4dd592e76d95549726b4dd307677dddfb606ff39dd6", + "sdk/javascript/sandbox/interfaces/SnapshotPaginator.md": "664425f9ee81f71adc63793fffdf505343352bbb1137f7d78271494b46dedfb1", + "sdk/javascript/sandbox/type-aliases/AgentBoxClientOpts.md": "64aec729e35ec0814bc3301666d14642f18394a12f4aa238beccbb6315a35895", + "sdk/javascript/sandbox/type-aliases/SandboxConnectOpts.md": "ae66e94fd6480eb211aa49bff925d5f9d01fb9536fba3ce6615975906fc4bdf3", + "sdk/javascript/sandbox/type-aliases/SandboxIamTokenType.md": "1f575132918286ee1cbca5c0e3a223accd0fe00d28ccf031cf8e736b088d7e5b", + "sdk/javascript/sandbox/type-aliases/SandboxInfoLifecycle.md": "ad7560c1024188fd0a6c190f48bd4a259fbb6d3255106bc0cbc0fad8327476b7", + "sdk/javascript/sandbox/type-aliases/SandboxLifecycle.md": "274738f80173ddc58d01b468bb0c339e8aeb0bf3ab7e197b2ddab4f556b0243d", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkInfo.md": "2d5c25cc1784395700e390d008103bc1c62f9020c5e8635c7aa550010f639fd3", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkOpts.md": "551b16a4d6d8c5db378fa9021d55beb0676a5d88f176d4eff5021dfeec7c22b2", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkRule.md": "2407697ee8aa28106a952f16b7d3aae7a27c597f33972ca28e0ab364333d045a", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkRuleInfo.md": "5143985e059f7b8446578bb3013b8c6c93a244d6ed0669530e9c98aa71d3fac8", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkRules.md": "f7f00b4bca4a7cd0729bc0134bb92aa73d00df75c213252216a81fcf875d9c1d", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkSelector.md": "ba05d6bddb2bb35ab92ec83264725619c1d86878786686c989130c61c4c67823", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkSelectorContext.md": "f717f41d57785dc7cb7188014ff59aea91bbe2f7f556092d83e92a1b222bb623", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkTransform.md": "0db495959159afb0d4816d9a9f7d9ec33ef5ff565eb01169422d1ccb10a863e9", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkTransformContext.md": "77973951984575b7ae0f9179a519a94b9fb93c0fbbbd52ca4f243ae872baa6a5", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkTransformResolver.md": "92d968a05dbaac2cfe20d97563c5816f025b41978b8fb6036d27233452a5e9da", + "sdk/javascript/sandbox/type-aliases/SandboxNetworkUpdate.md": "964f680dfcef1e190eeee06fa06186569f1ce7d65579df82cc94c2660a24de33", + "sdk/javascript/sandbox/type-aliases/SandboxOnTimeout.md": "8d89c3eb4aaf39ad40b179856db0d22b517b49dae0c902c6829fe67391a9278d", + "sdk/javascript/sandbox/type-aliases/SandboxState.md": "0ea290904d6bf67818f5586ae47b80cc3761e8563e0b759a4f0ad3c72ffd7192", + "sdk/javascript/templates/README.md": "57dc38d9ce0359d1529bcc6f9800338036bae64f24959bd4e7eafe6f1a25abe7", + "sdk/javascript/templates/classes/TemplateBase.md": "3f0c1b8d93e4747b29c402d6d53fb9c60f779d1c99559377f62ff6245372c7c2", + "sdk/javascript/templates/interfaces/TemplateBuilder.md": "f4b96d1bef9e6ac5c36372ed535bb7a2235b3b0e2d253ffeee9d090a1ee74db3", + "sdk/javascript/templates/type-aliases/BuildInfo.md": "07f0d73989a851b005ed98b858217fcd73e0eaec2ac2daccc725f3d5f9d3015a", + "sdk/javascript/templates/type-aliases/BuildOptions.md": "5c5ab2e5dfa35a34bd97d0619fcf1eb47a11a260bb324d84d02d592790913a4b", + "sdk/javascript/templates/type-aliases/BuildStatusReason.md": "991742d64b8a6f92f6bc956f93fc1980a9b3c04dc78dda1f1f422378dac9f45b", + "sdk/javascript/templates/type-aliases/CopyItem.md": "a1692eb6da89f293c44d8312b35453f0f6713b1a19cdb368fe088723cd154ed7", + "sdk/javascript/templates/type-aliases/GetBuildStatusOptions.md": "d3a26c910c4f3ed4ff63d6fd68cbcdc80a5aecc931f93c9bbdb2533dbcc1d2c2", + "sdk/javascript/templates/type-aliases/McpServerName.md": "5c88d7b02b7c275f5bd1ec4a4a86e1bec27a55a2a25546ed1771a3f1711fc72e", + "sdk/javascript/templates/type-aliases/TemplateBuildStatus.md": "272e3116c5280cbc7613d5a9021068ec92309bf53542519e83a70e37adaab5b5", + "sdk/javascript/templates/type-aliases/TemplateBuildStatusResponse.md": "ef1e7685633b913997b5c618abc2638fd725f10632deb6133d9b255f94640040", + "sdk/javascript/templates/type-aliases/TemplateClass.md": "2287aaf46168fe65ff47c2ca902aeff348b6ff2976eba0ad1c768d871db97cbc", + "sdk/javascript/templates/type-aliases/TemplateTag.md": "db9caee2111abe51da86261bf7ea1657577ddd7328b4ce3832e4671e78bf75ae", + "sdk/javascript/templates/type-aliases/TemplateTagInfo.md": "bf887a3ec11193cd398a23bf82e60d2879844a298802b37e0f1ee6b02af5714e", + "sdk/javascript/templates/variables/Template.md": "554e460f82acae2278f3a4a305875ea4f16128b3bdd8852403d3b8c6d37d21b4", "sdk/python/code-interpreter-async.md": "2fcf8b77695cab09d90940343d955f0cf18de1d28a37f95032f967df286957e2", "sdk/python/code-interpreter-sync.md": "51d85e86292e41cfcc94b232d7f451e5c1d45d3bbff03f21f9e677695aa0d18a", "sdk/python/exceptions.md": "804b83597afdfa8a82ad4c40fae2327f00c84d557097d56afef7cb7ccd694144", diff --git a/reference/openapi/markdown/assignTemplateTags.md b/reference/openapi/markdown/assignTemplateTags.md new file mode 100644 index 00000000..a451a7e2 --- /dev/null +++ b/reference/openapi/markdown/assignTemplateTags.md @@ -0,0 +1,85 @@ +# POST /templates/tags + +Assign template tags + +Assign tag(s) to a template build + +## Request body + +Required: yes + +### application/json + +Schema: `AssignTemplateTagsRequest` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `target` | `string` | yes | Target template in "name:tag" format | +| `tags` | `array` | yes | Tags to assign to the template | + +## Responses + +### 201 + +Tag assigned successfully + +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 | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/composeFiles.md b/reference/openapi/markdown/composeFiles.md new file mode 100644 index 00000000..e3e23674 --- /dev/null +++ b/reference/openapi/markdown/composeFiles.md @@ -0,0 +1,99 @@ +# POST /files/compose + +Compose multiple files into a single file using zero-copy concatenation. Source files are deleted after successful composition. + +## Request body + +Required: yes + +### application/json + +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 | + +## Responses + +### 200 + +Files composed successfully + +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. | + +### 400 + +Invalid path + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | + +### 401 + +Invalid user + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | + +### 404 + +File not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | + +### 500 + +Internal server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | + +### 507 + +Not enough disk space + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | diff --git a/reference/openapi/markdown/connectSandbox.md b/reference/openapi/markdown/connectSandbox.md new file mode 100644 index 00000000..e1fd6081 --- /dev/null +++ b/reference/openapi/markdown/connectSandbox.md @@ -0,0 +1,115 @@ +# POST /sandboxes/{sandboxID}/connect + +Connect sandbox + +Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. + +## Parameters + +| Name | In | Required | Type | Description | +| --- | --- | --- | --- | --- | +| `sandboxID` | path | yes | `string` | | + +## Request body + +Required: yes + +### application/json + +Schema: `ConnectSandbox` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `timeout` | `integer` | yes | Timeout in seconds from the current time after which the sandbox should expire | + +## Responses + +### 200 + +The sandbox was already running + +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 | +| `clientID` | `string` | yes | Identifier of the client | +| `envdVersion` | `EnvdVersion` | yes | Version of the envd running in the sandbox | +| `envdAccessToken` | `string` | no | Access token used for envd communication | +| `trafficAccessToken` | `string` | no | Token required for accessing sandbox via proxy. | +| `domain` | `string` | no | Base domain where the sandbox traffic is accessible | + +### 201 + +The sandbox was resumed successfully + +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 | +| `clientID` | `string` | yes | Identifier of the client | +| `envdVersion` | `EnvdVersion` | yes | Version of the envd running in the sandbox | +| `envdAccessToken` | `string` | no | Access token used for envd communication | +| `trafficAccessToken` | `string` | no | Token required for accessing sandbox via proxy. | +| `domain` | `string` | no | Base domain where the sandbox traffic is accessible | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/createSandbox.md b/reference/openapi/markdown/createSandbox.md new file mode 100644 index 00000000..178f820e --- /dev/null +++ b/reference/openapi/markdown/createSandbox.md @@ -0,0 +1,89 @@ +# POST /sandboxes + +Create sandbox + +Create a sandbox from the template + +## Request body + +Required: yes + +### application/json + +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. | +| `volumeMounts` | `array` | no | | + +## Responses + +### 201 + +The sandbox was created successfully + +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 | +| `clientID` | `string` | yes | Identifier of the client | +| `envdVersion` | `EnvdVersion` | yes | Version of the envd running in the sandbox | +| `envdAccessToken` | `string` | no | Access token used for envd communication | +| `trafficAccessToken` | `string` | no | Token required for accessing sandbox via proxy. | +| `domain` | `string` | no | Base domain where the sandbox traffic is accessible | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/createSnapshot.md b/reference/openapi/markdown/createSnapshot.md new file mode 100644 index 00000000..d98014d1 --- /dev/null +++ b/reference/openapi/markdown/createSnapshot.md @@ -0,0 +1,90 @@ +# POST /sandboxes/{sandboxID}/snapshots + +Create snapshot + +Create a persistent snapshot from the sandbox's current state. Snapshots can be used to create new sandboxes and persist beyond the original sandbox's lifetime. + +## Parameters + +| Name | In | Required | Type | Description | +| --- | --- | --- | --- | --- | +| `sandboxID` | path | yes | `string` | | + +## Request body + +Required: yes + +### application/json + +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. | + +## Responses + +### 201 + +Snapshot created successfully + +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) | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/createTemplate.md b/reference/openapi/markdown/createTemplate.md new file mode 100644 index 00000000..35b027f1 --- /dev/null +++ b/reference/openapi/markdown/createTemplate.md @@ -0,0 +1,93 @@ +# POST /v3/templates + +Create template (v3) + +Create a new template + +## Request body + +Required: yes + +### application/json + +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 | +| `alias` | `string` | no | Alias of the template. Deprecated, use name instead. | +| `teamID` | `string` | no | Identifier of the team | +| `cpuCount` | `CPUCount` | no | CPU cores for the sandbox | +| `memoryMB` | `MemoryMB` | no | Memory for the sandbox in MiB | + +## Responses + +### 202 + +The build was requested successfully + +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 | +| `aliases` | `array` | yes | Aliases of the template | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 403 + +Forbidden + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/deleteTemplate.md b/reference/openapi/markdown/deleteTemplate.md new file mode 100644 index 00000000..0605ffb7 --- /dev/null +++ b/reference/openapi/markdown/deleteTemplate.md @@ -0,0 +1,43 @@ +# DELETE /templates/{templateID} + +Delete template + +Delete a template + +## Parameters + +| Name | In | Required | Type | Description | +| --- | --- | --- | --- | --- | +| `templateID` | path | yes | `string` | | + +## Responses + +### 204 + +The template was deleted successfully + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/deleteTemplateTags.md b/reference/openapi/markdown/deleteTemplateTags.md new file mode 100644 index 00000000..ce46d65c --- /dev/null +++ b/reference/openapi/markdown/deleteTemplateTags.md @@ -0,0 +1,76 @@ +# DELETE /templates/tags + +Delete template tags + +Delete multiple tags from templates + +## Request body + +Required: yes + +### application/json + +Schema: `DeleteTemplateTagsRequest` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `name` | `string` | yes | Name of the template | +| `tags` | `array` | yes | Tags to delete | + +## Responses + +### 204 + +Tags deleted successfully + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/downloadFile.md b/reference/openapi/markdown/downloadFile.md new file mode 100644 index 00000000..4557ea3a --- /dev/null +++ b/reference/openapi/markdown/downloadFile.md @@ -0,0 +1,87 @@ +# GET /files + +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. | + +## Responses + +### 200 + +Entire file downloaded successfully. + +Content-Type: `application/octet-stream` + +Schema: `string` + +### 400 + +Invalid path + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | + +### 401 + +Invalid user + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | + +### 404 + +File not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | + +### 406 + +Requested encoding is not supported + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | + +### 500 + +Internal server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `message` | `string` | yes | Error message | +| `code` | `integer` | yes | Error code | diff --git a/reference/openapi/markdown/forkSandbox.md b/reference/openapi/markdown/forkSandbox.md new file mode 100644 index 00000000..d345493d --- /dev/null +++ b/reference/openapi/markdown/forkSandbox.md @@ -0,0 +1,86 @@ +# POST /sandboxes/{sandboxID}/fork + +Fork sandbox + +Fork the sandbox: checkpoint the running sandbox in place (it is briefly paused, snapshotted with its full memory state, and resumed on its node, keeping its ID and expiration untouched) and create count new sandboxes from that snapshot. Returns one result per requested fork, each carrying either the created sandbox or the error that prevented it from starting. A non-201 status means the request failed before any fork was attempted. + +## Parameters + +| Name | In | Required | Type | Description | +| --- | --- | --- | --- | --- | +| `sandboxID` | path | yes | `string` | | + +## Request body + +Required: no + +### application/json + +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. | + +## Responses + +### 201 + +The sandbox was snapshotted and the forks were attempted; each entry reports one fork's outcome + +Content-Type: `application/json` + +Schema: `array` + +### 409 + +Conflict + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getEnvironmentHealth.md b/reference/openapi/markdown/getEnvironmentHealth.md new file mode 100644 index 00000000..6340668e --- /dev/null +++ b/reference/openapi/markdown/getEnvironmentHealth.md @@ -0,0 +1,9 @@ +# GET /health + +Check the health of the service + +## Responses + +### 204 + +The service is healthy diff --git a/reference/openapi/markdown/getEnvironmentMetrics.md b/reference/openapi/markdown/getEnvironmentMetrics.md new file mode 100644 index 00000000..3c09e56a --- /dev/null +++ b/reference/openapi/markdown/getEnvironmentMetrics.md @@ -0,0 +1,26 @@ +# GET /metrics + +Service stats + +## Responses + +### 200 + +The resource usage metrics of the service + +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 | diff --git a/reference/openapi/markdown/getEnvironmentVariables.md b/reference/openapi/markdown/getEnvironmentVariables.md new file mode 100644 index 00000000..41b53968 --- /dev/null +++ b/reference/openapi/markdown/getEnvironmentVariables.md @@ -0,0 +1,13 @@ +# GET /envs + +Environment variables + +## Responses + +### 200 + +Environment variables + +Content-Type: `application/json` + +Schema: `EnvVars` diff --git a/reference/openapi/markdown/getSandbox.md b/reference/openapi/markdown/getSandbox.md new file mode 100644 index 00000000..0fdb6e4b --- /dev/null +++ b/reference/openapi/markdown/getSandbox.md @@ -0,0 +1,81 @@ +# GET /sandboxes/{sandboxID} + +Sandbox + +Get a sandbox by id + +## Parameters + +| Name | In | Required | Type | Description | +| --- | --- | --- | --- | --- | +| `sandboxID` | path | yes | `string` | | + +## Responses + +### 200 + +Successfully returned the sandbox + +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 | +| `clientID` | `string` | yes | Identifier of the client | +| `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 | +| `envdAccessToken` | `string` | no | Access token used for envd communication | +| `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. | +| `volumeMounts` | `array` | no | | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getSandboxLogs.md b/reference/openapi/markdown/getSandboxLogs.md new file mode 100644 index 00000000..c949e8b0 --- /dev/null +++ b/reference/openapi/markdown/getSandboxLogs.md @@ -0,0 +1,71 @@ +# GET /v2/sandboxes/{sandboxID}/logs + +Sandbox logs (v2) + +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 | + +## Responses + +### 200 + +Successfully returned the sandbox logs + +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 | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getSandboxMetrics.md b/reference/openapi/markdown/getSandboxMetrics.md new file mode 100644 index 00000000..c609ad53 --- /dev/null +++ b/reference/openapi/markdown/getSandboxMetrics.md @@ -0,0 +1,75 @@ +# GET /sandboxes/{sandboxID}/metrics + +Sandbox metrics + +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` | | + +## Responses + +### 200 + +Successfully returned the sandbox metrics + +Content-Type: `application/json` + +Schema: `array` + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getTeamMetrics.md b/reference/openapi/markdown/getTeamMetrics.md new file mode 100644 index 00000000..a6fc57ef --- /dev/null +++ b/reference/openapi/markdown/getTeamMetrics.md @@ -0,0 +1,75 @@ +# GET /teams/{teamID}/metrics + +Team metrics + +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` | | + +## Responses + +### 200 + +Successfully returned the team metrics + +Content-Type: `application/json` + +Schema: `array` + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 403 + +Forbidden + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getTeamMetricsMax.md b/reference/openapi/markdown/getTeamMetricsMax.md new file mode 100644 index 00000000..47b3519f --- /dev/null +++ b/reference/openapi/markdown/getTeamMetricsMax.md @@ -0,0 +1,82 @@ +# GET /teams/{teamID}/metrics/max + +Maximum team metrics + +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 | + +## Responses + +### 200 + +Successfully returned the team metrics + +Content-Type: `application/json` + +Schema: `MaxTeamMetric` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `timestamp` | `string` | yes | Timestamp of the metric entry | +| `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 | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 403 + +Forbidden + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getTemplate.md b/reference/openapi/markdown/getTemplate.md new file mode 100644 index 00000000..55c9bce8 --- /dev/null +++ b/reference/openapi/markdown/getTemplate.md @@ -0,0 +1,61 @@ +# GET /templates/{templateID} + +List template builds + +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 | + +## Responses + +### 200 + +Successfully returned the template with its builds + +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 | +| `aliases` | `array` | yes | Aliases of the template | +| `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 | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getTemplateBuildLogs.md b/reference/openapi/markdown/getTemplateBuildLogs.md new file mode 100644 index 00000000..bebe67f7 --- /dev/null +++ b/reference/openapi/markdown/getTemplateBuildLogs.md @@ -0,0 +1,73 @@ +# GET /templates/{templateID}/builds/{buildID}/logs + +Template build logs + +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 | + +## Responses + +### 200 + +Successfully returned the template build logs + +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 | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getTemplateBuildStatus.md b/reference/openapi/markdown/getTemplateBuildStatus.md new file mode 100644 index 00000000..3f057ab1 --- /dev/null +++ b/reference/openapi/markdown/getTemplateBuildStatus.md @@ -0,0 +1,73 @@ +# GET /templates/{templateID}/builds/{buildID}/status + +Template build status + +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` | | + +## Responses + +### 200 + +Successfully returned the template + +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 | | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getTemplateByAlias.md b/reference/openapi/markdown/getTemplateByAlias.md new file mode 100644 index 00000000..f6e50807 --- /dev/null +++ b/reference/openapi/markdown/getTemplateByAlias.md @@ -0,0 +1,78 @@ +# GET /templates/aliases/{alias} + +Check template alias + +Check if template with given alias exists + +## Parameters + +| Name | In | Required | Type | Description | +| --- | --- | --- | --- | --- | +| `alias` | path | yes | `string` | | + +## Responses + +### 200 + +Successfully queried template by alias + +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 | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 403 + +Forbidden + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/getTemplateUploadUrl.md b/reference/openapi/markdown/getTemplateUploadUrl.md new file mode 100644 index 00000000..361fceb9 --- /dev/null +++ b/reference/openapi/markdown/getTemplateUploadUrl.md @@ -0,0 +1,79 @@ +# GET /templates/{templateID}/files/{hash} + +Template build file upload URL + +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` | | + +## Responses + +### 201 + +The upload link where to upload the tar file + +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 | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/killSandbox.md b/reference/openapi/markdown/killSandbox.md new file mode 100644 index 00000000..66cb3fb7 --- /dev/null +++ b/reference/openapi/markdown/killSandbox.md @@ -0,0 +1,56 @@ +# DELETE /sandboxes/{sandboxID} + +Kill sandbox + +Kill a sandbox + +## Parameters + +| Name | In | Required | Type | Description | +| --- | --- | --- | --- | --- | +| `sandboxID` | path | yes | `string` | | + +## Responses + +### 204 + +The sandbox was killed successfully + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/listSandboxMetrics.md b/reference/openapi/markdown/listSandboxMetrics.md new file mode 100644 index 00000000..d814a7b3 --- /dev/null +++ b/reference/openapi/markdown/listSandboxMetrics.md @@ -0,0 +1,64 @@ +# GET /sandboxes/metrics + +List sandbox metrics + +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 | + +## Responses + +### 200 + +Successfully returned all running sandboxes with metrics + +Content-Type: `application/json` + +Schema: `SandboxesWithMetrics` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `sandboxes` | `object` | yes | | + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/listSandboxes.md b/reference/openapi/markdown/listSandboxes.md new file mode 100644 index 00000000..3238b453 --- /dev/null +++ b/reference/openapi/markdown/listSandboxes.md @@ -0,0 +1,63 @@ +# GET /v2/sandboxes + +List sandboxes (v2) + +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 | + +## Responses + +### 200 + +Successfully returned all running sandboxes + +Content-Type: `application/json` + +Schema: `array` + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 400 + +Bad request + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/listSnapshots.md b/reference/openapi/markdown/listSnapshots.md new file mode 100644 index 00000000..d3022aae --- /dev/null +++ b/reference/openapi/markdown/listSnapshots.md @@ -0,0 +1,50 @@ +# GET /snapshots + +List snapshots + +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 | + +## Responses + +### 200 + +Successfully returned snapshots + +Content-Type: `application/json` + +Schema: `array` + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/listTemplateTags.md b/reference/openapi/markdown/listTemplateTags.md new file mode 100644 index 00000000..102da9d4 --- /dev/null +++ b/reference/openapi/markdown/listTemplateTags.md @@ -0,0 +1,73 @@ +# GET /templates/{templateID}/tags + +List template tags + +List all tags for a template + +## Parameters + +| Name | In | Required | Type | Description | +| --- | --- | --- | --- | --- | +| `templateID` | path | yes | `string` | | + +## Responses + +### 200 + +Successfully returned the template tags + +Content-Type: `application/json` + +Schema: `array` + +### 401 + +Authentication error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 403 + +Forbidden + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 404 + +Not found + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | + +### 500 + +Server error + +Content-Type: `application/json` + +Schema: `Error` + +| Field | Type | Required | Description | +| --- | --- | --- | --- | +| `code` | `integer` | yes | Error code | +| `message` | `string` | yes | Error | diff --git a/reference/openapi/markdown/listTemplates.md b/reference/openapi/markdown/listTemplates.md new file mode 100644 index 00000000..44bbec7c --- /dev/null +++ b/reference/openapi/markdown/listTemplates.md @@ -0,0 +1,75 @@ +# GET /v2/templates + +List templates (v2) + +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 | + +## Responses + +### 200 + +Successfully returned all templates + +Content-Type: `application/json` + +Schema: `array