Mish Ushakov
4fcf7cb150
The specs in `spec/` were copied from their source repos by hand and had
drifted ~2,400 lines behind infra, so they are now imported with
Copybara (`copy.bara.sky`, run in a pinned Docker image by
`scripts/fetch-spec.sh`): `make codegen` re-fetches them at the commits
pinned in `spec/infra-ref` and `spec/belt-ref` before generating, and
the generated-files CI check fails if the tracked copies don't match the
pins. Regenerating from the current pins picks up the accumulated spec
changes in the generated JS/Python clients (renamed request schemas,
`SandboxNetworkConfig`, `SandboxIam` workload identity,
`FILE_TYPE_SYMLINK`, access-token auth deprecation, volume path-metadata
tweaks). The one handwritten SDK change follows from that: the public
`FileType` enums gain a `SYMLINK` member (JS and both Python surfaces)
so entries envd reports as symlinks show up in `files.list()` and
`getInfo()`/`get_info()` instead of being silently skipped as unknown
types. The custom `spec/remove_extra_tags.py` tag-filtering script is
replaced by Redocly CLI's `filter-in` decorator (`redocly.yaml`), which
produces identical generated JS output; a `filter-out` decorator
additionally drops any operation or component schema the upstream specs
mark `x-not-implemented: true` (currently the SOCKS5
`SandboxEgressProxyConfig`/`egressProxy` surface, which infra flagged as
spec-only); each SDK's bundle now goes to its own gitignored
`spec/openapi_generated.<api>.yml` instead of both pipelines overwriting
one shared file; Python client models now list fields in spec order
instead of alphabetical (mechanical reordering only — construct models
with keyword args). Spec fetches try whatever GitHub token is available
and fall back to the tracked copies with a warning (the public infra
specs also fetch anonymously); in CI a short-lived belt-scoped token is
minted from the org-wide Autofixer GitHub App (no new secrets), so fork
PRs simply fall back for the belt spec; the CI workflows also cache the
Copybara image alongside the codegen image, and the previously ignored
`CODEGEN_IMAGE` env is honored by the Makefile.
## Usage
```sh
# update the specs: bump a pin, then regenerate
echo <infra-commit-sha> > spec/infra-ref
make codegen
# fetch a single spec without regenerating
pnpm fetch:api-spec # spec/openapi.yml from infra
pnpm fetch:envd-spec # spec/envd/ from infra
pnpm fetch:volume-spec # spec/openapi-volumecontent.yml from belt
# try the latest spec without touching the pin
E2B_INFRA_REF=main pnpm fetch:api-spec
# change which endpoint tags an SDK exposes
$EDITOR redocly.yaml && make codegen
```
```ts
// symlinks are now visible in the filesystem API (JS; same shape in Python)
const entries = await sandbox.files.list('/home/user')
const link = entries.find((e) => e.type === FileType.SYMLINK)
console.log(link?.symlinkTarget)
```
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
36 lines
1.3 KiB
YAML
36 lines
1.3 KiB
YAML
# Filters the synced REST API spec (spec/openapi.yml) down to the endpoint
|
|
# tags each SDK exposes; everything else (admin, access-tokens, api-keys,
|
|
# untagged endpoints like /health) is dropped. The SDK generate pipelines run
|
|
# `redocly bundle <api> -o spec/openapi_generated.<api>.yml` before invoking
|
|
# their client generators. The js-sdk list additionally keeps `auth` because
|
|
# the CLI reaches /teams through the js-sdk's generated schema.
|
|
#
|
|
# filter-out drops any node (operation or component schema) the upstream
|
|
# specs mark `x-not-implemented: true`. It has no applyTo on purpose: the
|
|
# flag must work on schemas as well as operations. A kept operation that
|
|
# still references a dropped schema loses that media-type entry rather
|
|
# than keeping a dangling $ref.
|
|
apis:
|
|
js-sdk:
|
|
root: spec/openapi.yml
|
|
decorators:
|
|
filter-in:
|
|
property: tags
|
|
value: [sandboxes, snapshots, templates, tags, auth, volumes]
|
|
matchStrategy: any
|
|
applyTo: Operation
|
|
filter-out:
|
|
property: x-not-implemented
|
|
value: [true]
|
|
python-sdk:
|
|
root: spec/openapi.yml
|
|
decorators:
|
|
filter-in:
|
|
property: tags
|
|
value: [sandboxes, snapshots, templates, tags, volumes]
|
|
matchStrategy: any
|
|
applyTo: Operation
|
|
filter-out:
|
|
property: x-not-implemented
|
|
value: [true]
|