wehub-resource-sync
e0e362d700
SDK Tests / changes (push) Successful in 2m29s
Real E2E Tests / changes (push) Successful in 2m29s
Deploy Docs Pages / build (push) Has been cancelled
Deploy Docs Pages / deploy (push) Has been cancelled
Real E2E Tests / JavaScript E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / Python E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / Java E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / C# E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / Go E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / Real E2E CI (push) Has been cancelled
SDK Tests / SDK CI (push) Has been cancelled
SDK Tests / CLI Tests (push) Has been cancelled
SDK Tests / Python SDK Quality (code-interpreter) (push) Has been cancelled
SDK Tests / Python SDK Quality (sandbox) (push) Has been cancelled
SDK Tests / Python SDK Tests (code-interpreter) (push) Has been cancelled
SDK Tests / JavaScript SDK Quality And Tests (code-interpreter) (push) Has been cancelled
SDK Tests / JavaScript SDK Quality And Tests (sandbox) (push) Has been cancelled
SDK Tests / Python SDK Tests (sandbox) (push) Has been cancelled
SDK Tests / CLI Quality (push) Has been cancelled
SDK Tests / Kotlin SDK Quality And Tests (sandbox) (push) Has been cancelled
SDK Tests / Kotlin SDK Quality And Tests (code-interpreter) (push) Has been cancelled
SDK Tests / C# SDK Quality And Tests (code-interpreter) (push) Has been cancelled
SDK Tests / C# SDK Quality And Tests (sandbox) (push) Has been cancelled
SDK Tests / Go SDK Quality And Tests (push) Has been cancelled
2.1 KiB
2.1 KiB
Specs AGENTS
You are maintaining OpenSandbox public API contracts. Treat the spec files in this directory as the source of truth for public interfaces and prefer additive changes.
Scope
sandbox-lifecycle.ymldiagnostic-api.ymlexecd-api.yamlegress-api.yamlREADME*.md
When a contract change affects downstream code, also read the nearest consumer guide:
../server/AGENTS.mdfor lifecycle server impact../sdks/AGENTS.mdfor SDK-facing contract changes- component README/DEVELOPMENT files under
../components/for execd or egress impact ../cli/README.mdfor CLI-visible diagnostics, lifecycle, or egress changes
Contract Map
sandbox-lifecycle.yml: lifecycle API used byserver/,cli/, and sandbox SDKsdiagnostic-api.yml: diagnostics API used by server diagnostics, CLI diagnostics, and troubleshooting flowsexecd-api.yaml: execution API used bycomponents/execd/and code-interpreter SDKsegress-api.yaml: egress sidecar API and related docs
Commands
Lifecycle consumer validation:
cd server
uv sync --all-groups
uv run ruff check
uv run pytest
SDK workspace setup for affected SDK regeneration:
cd sdks
pnpm install --frozen-lockfile
Guardrails
Always:
- Keep operation IDs, schema names, examples, and descriptions consistent with existing naming.
- Regenerate derived outputs after spec edits.
- Update affected consumers in the same change when practical.
- Keep spec examples aligned with server schemas and generated SDK models.
- Call out downstream areas you did not verify.
Ask first:
- Breaking contract changes
- Renaming or removing public fields or operations
- Adding a new top-level API surface without implementation alignment
Never:
- Rename or remove public fields without approval.
- Hand-edit derived outputs without updating the source spec.
- Assume a spec-only edit is isolated from server, SDK, docs, or release impact.
Good Patterns
- Concrete examples and descriptions when behavior changes
- Explicit backward-compatible field additions instead of field redefinition
- Contract and consumer updates landing together