docs(sdk): rename team to project in snapshot docstrings#1562
docs(sdk): rename team to project in snapshot docstrings#1562mishushakov wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: e512752 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
PR SummaryLow Risk Overview Generated API client text is unchanged ( If the API still returns team-scoped names on the wire, the new examples may not match real Reviewed by Cursor Bugbot for commit e512752. Bugbot is set up for automated code reviews on this repo. Configure here. |
Package ArtifactsBuilt from d3d39a9. Download artifacts from this workflow run. JS SDK ( npm install ./e2b-2.35.1-team-to-project-sdk-rename.0.tgzCLI ( npm install ./e2b-cli-2.13.4-team-to-project-sdk-rename.0.tgzPython SDK ( pip install ./e2b-2.34.0+team.to.project.sdk.rename-py3-none-any.whl |
There was a problem hiding this comment.
This is a small, mechanical docstring change, but the new "project" terminology isn't backed by the actual API yet — the generated client code and spec/openapi.yml still document team-slug/my-team naming, and I don't see a related backend change in history. Worth a quick human check that this rename is actually planned/coordinated before merging docs that describe behavior the API doesn't yet implement.
Extended reasoning...
Overview
This PR only touches docstrings/comments in the hand-written JS and Python SDK files (sandboxApi.ts, sandbox_api.py, sandbox_async/main.py, sandbox_sync/main.py) plus a changeset. It replaces "team" terminology with "project" in snapshot-related examples (e.g. my-team/my-snapshot → my-project/my-snapshot, team-slug → project-slug). No exported symbols, function signatures, or runtime logic change.
Security risks
None — this is a comment-only change with no effect on request/response handling, auth, or data flow.
Level of scrutiny
Normally a pure docstring change like this would be a clear auto-approve. However, I verified (matching what Cursor's bot already flagged) that the generated API client code (schema.gen.ts, snapshot_info.py) and spec/openapi.yml still consistently use "team"/team-slug terminology for the exact same fields this PR is renaming. I also checked git history for any related backend/spec rename and found none. So the hand-written docstrings now describe a naming scheme (project-slug/...) that doesn't match what the API actually returns today, which could mislead SDK users about the real format of SnapshotInfo.names or the name filter.
Other factors
The PR description acknowledges the generated client and OpenAPI spec were left untouched "until the backend exposes project-named endpoints," suggesting this may be intentionally ahead of a planned backend change — but there's no visible evidence in this repo confirming that plan is confirmed/scheduled. Given the risk of shipping documentation that contradicts actual current behavior, a human should confirm the terminology change is coordinated with the backend before merging.
Renames team → project terminology in the JS and Python SDK snapshot docstrings: the
list_snapshots/snapshot listnamefilter example now reads"my-project/my-snapshot", andSnapshotInfo.namesis documented as "including project slug and tag (e.g. project-slug/my-snapshot:v2)".Documentation-only — no exported names, runtime behavior, or wire protocol change; generated API clients and
spec/openapi.ymlare intentionally untouched until the backend exposes project-named endpoints. Includes a patch changeset fore2band@e2b/python-sdk.🤖 Generated with Claude Code