Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions reference/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"files": {
"connect/filesystem.md": "1cc1e81386810d3c5c999458e02340e3becb3da8138d943558584094750e5aae",
"connect/process.md": "037574455e9e8c5159c391d8c007e7272560f62c4e5ee681f8aec29f9cd24539",
"openapi/control-plane.yml": "95df3951c30223827e4933f1dab8c6e2c75a2a8d81269646f807427d11078548",
"openapi/envd.yml": "30a0fba3b410c77db6b50b674f0ef9d110bf626ca2558820b5a6a05e4640cf19",
"openapi/control-plane.yml": "f3009ea28f824b61092142caf527a062f59c791bc760a7810a4fb9dec8226a29",
"openapi/envd.yml": "83bc85bf7b4084105ac9ffeec708d04d0e14ab275026d616c30de31caea62589",
"openapi/markdown/assignTemplateTags.md": "3ec3dc705cbda5780d0a9e78234c7777f014784b2ec193821b6f5bb2ea26ec57",
"openapi/markdown/composeFiles.md": "3e5c37b40268689b6e5287a906c75b80f71fefafe94205c6327c976ca0594d5c",
"openapi/markdown/connectSandbox.md": "9106d09a6f525aa0bcbd1eed06de62a4d015d1f6fa63496ccb6aebbebb3ad332",
Expand Down
65 changes: 65 additions & 0 deletions reference/openapi/control-plane.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1684,6 +1684,11 @@ components:
maskedValueSuffix:
type: string
description: Suffix used in masked version of the token or key
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
tags:
- name: sandboxes
- name: snapshots
Expand Down Expand Up @@ -1733,6 +1738,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getTeamMetrics
security:
- ApiKeyAuth: []
/teams/{teamID}/metrics/max:
get:
summary: Maximum team metrics
Expand Down Expand Up @@ -1782,6 +1789,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getTeamMetricsMax
security:
- ApiKeyAuth: []
/sandboxes:
post:
summary: Create sandbox
Expand All @@ -1808,6 +1817,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: createSandbox
security:
- ApiKeyAuth: []
/v2/sandboxes:
get:
summary: List sandboxes (v2)
Expand Down Expand Up @@ -1855,6 +1866,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: listSandboxes
security:
- ApiKeyAuth: []
/sandboxes/metrics:
get:
summary: List sandbox metrics
Expand Down Expand Up @@ -1887,6 +1900,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: listSandboxMetrics
security:
- ApiKeyAuth: []
/v2/sandboxes/{sandboxID}/logs:
get:
summary: Sandbox logs (v2)
Expand Down Expand Up @@ -1948,6 +1963,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getSandboxLogs
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}:
get:
summary: Sandbox
Expand All @@ -1970,6 +1987,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getSandbox
security:
- ApiKeyAuth: []
delete:
summary: Kill sandbox
description: Kill a sandbox
Expand All @@ -1987,6 +2006,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: killSandbox
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}/metrics:
get:
summary: Sandbox metrics
Expand Down Expand Up @@ -2029,6 +2050,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getSandboxMetrics
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}/pause:
post:
summary: Pause sandbox
Expand All @@ -2055,6 +2078,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: pauseSandbox
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}/fork:
post:
summary: Fork sandbox
Expand Down Expand Up @@ -2093,6 +2118,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: forkSandbox
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}/connect:
post:
summary: Connect sandbox
Expand Down Expand Up @@ -2130,6 +2157,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: connectSandbox
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}/timeout:
post:
summary: Set sandbox timeout
Expand All @@ -2156,6 +2185,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: setSandboxTimeout
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}/network:
put:
summary: Update sandbox network
Expand Down Expand Up @@ -2184,6 +2215,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: updateSandboxNetwork
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}/refreshes:
post:
summary: Refresh sandbox
Expand All @@ -2205,6 +2238,8 @@ paths:
'404':
$ref: '#/components/responses/404'
operationId: refreshSandbox
security:
- ApiKeyAuth: []
/sandboxes/{sandboxID}/snapshots:
post:
summary: Create snapshot
Expand Down Expand Up @@ -2237,6 +2272,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: createSnapshot
security:
- ApiKeyAuth: []
/snapshots:
get:
summary: List snapshots
Expand Down Expand Up @@ -2276,6 +2313,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: listSnapshots
security:
- ApiKeyAuth: []
/v3/templates:
post:
summary: Create template (v3)
Expand Down Expand Up @@ -2304,6 +2343,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: createTemplate
security:
- ApiKeyAuth: []
/v2/templates:
get:
summary: List templates (v2)
Expand Down Expand Up @@ -2340,6 +2381,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: listTemplates
security:
- ApiKeyAuth: []
/templates/{templateID}/files/{hash}:
get:
summary: Template build file upload URL
Expand Down Expand Up @@ -2370,6 +2413,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getTemplateUploadUrl
security:
- ApiKeyAuth: []
/templates/{templateID}:
get:
summary: List template builds
Expand All @@ -2395,6 +2440,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getTemplate
security:
- ApiKeyAuth: []
delete:
summary: Delete template
description: Delete a template
Expand All @@ -2410,6 +2457,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: deleteTemplate
security:
- ApiKeyAuth: []
/v2/templates/{templateID}/builds/{buildID}:
post:
summary: Start template build (v2)
Expand All @@ -2433,6 +2482,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: startTemplateBuild
security:
- ApiKeyAuth: []
/v2/templates/{templateID}:
patch:
summary: Update template (v2)
Expand Down Expand Up @@ -2461,6 +2512,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: updateTemplate
security:
- ApiKeyAuth: []
/templates/{templateID}/builds/{buildID}/status:
get:
summary: Template build status
Expand Down Expand Up @@ -2506,6 +2559,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getTemplateBuildStatus
security:
- ApiKeyAuth: []
/templates/{templateID}/builds/{buildID}/logs:
get:
summary: Template build logs
Expand Down Expand Up @@ -2565,6 +2620,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getTemplateBuildLogs
security:
- ApiKeyAuth: []
/templates/tags:
post:
summary: Assign template tags
Expand Down Expand Up @@ -2593,6 +2650,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: assignTemplateTags
security:
- ApiKeyAuth: []
delete:
summary: Delete template tags
description: Delete multiple tags from templates
Expand All @@ -2616,6 +2675,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: deleteTemplateTags
security:
- ApiKeyAuth: []
/templates/{templateID}/tags:
get:
summary: List template tags
Expand All @@ -2642,6 +2703,8 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: listTemplateTags
security:
- ApiKeyAuth: []
/templates/aliases/{alias}:
get:
summary: Check template alias
Expand Down Expand Up @@ -2671,3 +2734,5 @@ paths:
'500':
$ref: '#/components/responses/500'
operationId: getTemplateByAlias
security:
- ApiKeyAuth: []
21 changes: 21 additions & 0 deletions reference/openapi/envd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ paths:
operationId: getEnvironmentHealth
tags:
- environment
security: []
/metrics:
get:
summary: Service stats
Expand All @@ -29,6 +30,9 @@ paths:
operationId: getEnvironmentMetrics
tags:
- environment
security:
- {}
- AccessTokenAuth: []
/envs:
get:
summary: Environment variables
Expand All @@ -42,6 +46,9 @@ paths:
operationId: getEnvironmentVariables
tags:
- environment
security:
- {}
- AccessTokenAuth: []
/files:
get:
summary: Download a file
Expand All @@ -66,6 +73,9 @@ paths:
'500':
$ref: '#/components/responses/InternalServerError'
operationId: downloadFile
security:
- {}
- AccessTokenAuth: []
post:
summary: Upload a file and ensure the parent directories exist. If the file
exists, it will be overwritten.
Expand Down Expand Up @@ -130,6 +140,9 @@ paths:
'507':
$ref: '#/components/responses/NotEnoughDiskSpace'
operationId: uploadFile
security:
- {}
- AccessTokenAuth: []
/files/compose:
post:
summary: Compose multiple files into a single file using zero-copy concatenation.
Expand Down Expand Up @@ -160,6 +173,9 @@ paths:
'507':
$ref: '#/components/responses/NotEnoughDiskSpace'
operationId: composeFiles
security:
- {}
- AccessTokenAuth: []
components:
parameters:
FilePath:
Expand Down Expand Up @@ -417,3 +433,8 @@ components:
required:
- nfs_target
- path
securitySchemes:
AccessTokenAuth:
type: apiKey
in: header
name: X-Access-Token
Loading
Loading