Skip to content

Commit e209853

Browse files
authored
Merge pull request #3 from abox-dev/docs-reference-filter
fix(reference): harden the public OpenAPI contract
2 parents b3750e1 + 1fd5b73 commit e209853

16 files changed

Lines changed: 476 additions & 629 deletions

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
Use pnpm for JavaScript packages and uv for Python packages.
2+
Use English exclusively in source code, comments, documentation, commit messages, and GitHub pull request titles and descriptions.
23
Keep the JavaScript and Python SDKs, including sync and async Python APIs, behaviorally aligned.
34
Run format checks, lint, type checks, unit tests, deterministic generation, builds, and package-install checks before committing.
45
The API and envd snapshots under spec/ are generated from mono/infra. Do not edit them manually. Update them with `make sync-specs MONO_DIR=/path/to/mono`, then run `make generate`.

reference-config/operations.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ schemaVersion: 1
22

33
controlPlane:
44
source: spec/openapi.yml
5+
publicAuthSchemes:
6+
- ApiKeyAuth
57
publicTags:
68
- sandboxes
79
- snapshots
@@ -41,6 +43,8 @@ controlPlane:
4143

4244
envd:
4345
source: spec/envd/envd.yaml
46+
publicAuthSchemes:
47+
- AccessTokenAuth
4448
operations:
4549
GET /health: { id: getEnvironmentHealth, group: environment, slug: health }
4650
GET /metrics: { id: getEnvironmentMetrics, group: environment, slug: metrics }

reference/manifest.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@
22
"files": {
33
"connect/filesystem.md": "1cc1e81386810d3c5c999458e02340e3becb3da8138d943558584094750e5aae",
44
"connect/process.md": "037574455e9e8c5159c391d8c007e7272560f62c4e5ee681f8aec29f9cd24539",
5-
"openapi/control-plane.yml": "f0a5b8c69f92bc19ed2bebb77d1fc097f991f8ecdd06cf439082eb73b64c93fe",
6-
"openapi/envd.yml": "e4d91017beb3885ef4b389ab23f30f43682ee6a2c01721275e6513d8cfe6217d",
5+
"openapi/control-plane.yml": "95df3951c30223827e4933f1dab8c6e2c75a2a8d81269646f807427d11078548",
6+
"openapi/envd.yml": "30a0fba3b410c77db6b50b674f0ef9d110bf626ca2558820b5a6a05e4640cf19",
77
"openapi/markdown/assignTemplateTags.md": "fa9f7b2fd59332151695fab853f7f29b253e8837bbd6d8fa669258a303622819",
88
"openapi/markdown/composeFiles.md": "c814b69b4721e1a8c1a4d202bfc38feccfd12576071a21af8d9380baf6c2ff28",
9-
"openapi/markdown/connectSandbox.md": "d2acb99ec38360e5146f06a895f96bd6034a9cd8a56ff8acbd727cc8d1bb8fa5",
10-
"openapi/markdown/createSandbox.md": "e17fc2aa20769eb0f4456aeaaf8e887af5faf3d4e9ed636e400bf08eaf401c17",
9+
"openapi/markdown/connectSandbox.md": "035437cfff8d3174ac6517b90c3da75dc338181ec19d07274cef46430453c6ed",
10+
"openapi/markdown/createSandbox.md": "d9934ce3b88e1aa9df092fbff4ad88b87136b6ed786c3c7ca1aba86b361ac51a",
1111
"openapi/markdown/createSnapshot.md": "b1aaf62afe3723c04fcd7c1f1b092a24a0342b28de2b680d6a9d0afc014ddc3b",
12-
"openapi/markdown/createTemplate.md": "4a9604d8cb7af1cb8c0da6b7e3bd56cfb7a20a4c91463013e55850f9854ea06c",
12+
"openapi/markdown/createTemplate.md": "6e9fe66bc4a9671fd778620064989117fd40a560d5a0e2db874e6ade707384c4",
1313
"openapi/markdown/deleteTemplate.md": "31f4140050bb8753a0e8294f4b60425695866b2a3930a861ed1657ec4fb07029",
1414
"openapi/markdown/deleteTemplateTags.md": "94e5f1831a4044ea6acb248326fba83d9c6f0123bd61a3b2c401426fcd434b82",
1515
"openapi/markdown/downloadFile.md": "3cded9f4d62b95e4fbb6bc4d548340c5943538010b04bfba690bfb042cd0ae4d",
1616
"openapi/markdown/forkSandbox.md": "e773314d8f074b168db204072097c2bff06fac52960d5a89db5172a980ab8668",
1717
"openapi/markdown/getEnvironmentHealth.md": "640c9435ce216a6fd0e5da7ee646d8527e5de428c946fad219946f5c1de5622a",
1818
"openapi/markdown/getEnvironmentMetrics.md": "32f7d61ddb8980caec0beaa3821b99e5f6ef90c0e812390d4d417844ec99acdc",
1919
"openapi/markdown/getEnvironmentVariables.md": "12803bbc7e3f2638e16f013ce05b2a688d8085739e38049c1022452fd7881e50",
20-
"openapi/markdown/getSandbox.md": "3cf849c2093a536b19858ec431162413cd8b5e66ae7fb344f83b881b331d15ca",
20+
"openapi/markdown/getSandbox.md": "697dcedd7f51a776705eae4e0ea0c358f93da5d7408fae0e779a7eba39c88130",
2121
"openapi/markdown/getSandboxLogs.md": "d5e3adfca5ff72d3b04ad8f2f5bb038ce429d8d7381cc37db33c9b4f393df047",
2222
"openapi/markdown/getSandboxMetrics.md": "cc810ac8bd47c0bf3903a2a529d5489af61611cb7268ef2327f93007d08d9467",
2323
"openapi/markdown/getTeamMetrics.md": "8cdaab8e8e3f089793e75ce6e831ee4effec72acf4f9297644503e175fc25368",
24-
"openapi/markdown/getTeamMetricsMax.md": "85ee15af0672e21484da2378da9ac0e5171d062eff30de3a70f2927056383ec0",
25-
"openapi/markdown/getTemplate.md": "43e22cc700d0bdcc85206d59db06bc9bea47d57bc4d418ec7c353e4b404939cb",
24+
"openapi/markdown/getTeamMetricsMax.md": "ec55664edb022a0d60573c0500a4d47c78a34a3a2cd538b842438fb569c97cb8",
25+
"openapi/markdown/getTemplate.md": "08d46844ebf9a8825375faa3ff447d4f79fd36d421e9ab576ca9aed266b861c6",
2626
"openapi/markdown/getTemplateBuildLogs.md": "a9a58101cfbb8317a2cbfb0bf8ba35cfdb237cb318c1010309fc34e74da81052",
2727
"openapi/markdown/getTemplateBuildStatus.md": "d27fafb869e7ec31271b71f54e82bd166f0548cafffbe3614d9b6bed9381f26b",
2828
"openapi/markdown/getTemplateByAlias.md": "df84543b45bdff8db21e5084eb046b0cc46333d0a18dd296c04f9639a1ad6d71",
@@ -40,7 +40,7 @@
4040
"openapi/markdown/updateSandboxNetwork.md": "30717801dfc58a1ddd3e7eb889af7ad2fec16ea7c6d8a13f8eb1356066165ac2",
4141
"openapi/markdown/updateTemplate.md": "0e18de978fc7005ec36645d003827354df933fb9e51ba218fbdea55639c0636a",
4242
"openapi/markdown/uploadFile.md": "acf5f7029d2b4de2ce96b50bb24f5e4495c188dfed878851ffe2f91e5b7b24d3",
43-
"openapi/operations.json": "740c58aa17455c219647713f1d3f9ea5bea7ea0aeff346436f8c1f1902c973d3",
43+
"openapi/operations.json": "1593bd80b73d87117a5ebf8211d0ba014e0170c84fca5fe9f1a82ec457a6b575",
4444
"sdk/cli/auth.md": "0b2c75262b0c0670c7bc0f0f3cbed65fbe4a16d6fe4437789a5685b8bf2174a1",
4545
"sdk/cli/sandbox.md": "0f59649197a6f42282a8b789c4384e8e41d2e525de414a22dffe073f0fca4d64",
4646
"sdk/cli/template.md": "f270b22b9ee10a9b954a14f24e04c5449b4d5823bb28002ffde3ed682594cfc5",

0 commit comments

Comments
 (0)