Files

T

Mish Ushakov 4fcf7cb150 feat: sync API specs from infra and belt with Copybara (#1564 )

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>

2026-07-24 16:37:02 +02:00

1.6 KiB

Raw Permalink Blame History

API specs

Most files in this directory are owned by other repositories and are synced here with Copybara (config in ../copy.bara.sky) — don't edit them by hand; change them in their source repository and re-sync:

openapi.yml, envd/envd.yaml, envd/filesystem/, envd/process/ are owned by the infra repository, pinned by infra-ref.
openapi-volumecontent.yml is owned by the private belt repository, pinned by belt-ref.

Fetches authenticate with a GitHub token when available (GITHUB_TOKEN, or being logged in with gh auth login); the public infra specs also fetch anonymously, while the volume-content spec needs a token with read access to belt. When a fetch fails, make codegen warns and falls back to the tracked copy.

make codegen re-fetches all of them at their pinned commits before generating the clients, and the generated-files CI check fails if the tracked copies don't match the pins. The files are stored byte-identical to upstream. To update the specs, point the pin at a newer commit and re-run make codegen. To fetch without regenerating:

pnpm fetch:api-spec     # openapi.yml
pnpm fetch:envd-spec    # envd spec
pnpm fetch:volume-spec  # openapi-volumecontent.yml
E2B_INFRA_REF=main pnpm fetch:api-spec     # try the latest without moving the pin
E2B_BELT_REF=main pnpm fetch:volume-spec

The remaining files (mcp-server.json, envd/buf-*.gen.yaml) are owned by this repository. The SDK generate pipelines filter openapi.yml down to the tags each SDK exposes with Redocly CLI (see ../redocly.yaml) before generating the clients.

1.6 KiB Raw Permalink Blame History

API specs

1.6 KiB

Raw Permalink Blame History