Uh oh!
There was an error while loading. Please reload this page.
docs: document POST /api/sandboxes/staged-files - #198
Conversation
Caution Review failedPull request was closed or merged during review No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis PR adds documentation for a new ChangesSandboxes File Staging Endpoint
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
1 issue found across 4 files (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="api-reference/openapi/content.json">
<violation number="1" location="api-reference/openapi/content.json:361">
P1: The endpoint path appears mistyped as `/api/sandboxes/stage-files`; this should remain `/api/sandboxes/staged-files` to match the API being documented.</violation>
</file>
Tip: Review your code locally with the cubic CLI to iterate faster.
Uh oh!
There was an error while loading. Please reload this page.
You're iterating quickly on this pull request. To help protect your rate limits, cubic has paused automatic reviews on new pushes for now—when you're ready for another review, comment |
Pairs with api PR adding the Vercel Blob client-upload handshake endpoint. Adds OpenAPI entry to content.json, MDX page, and sandboxes nav entry. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Page documents POST /api/sandboxes/files (the GitHub-commit half of the sandbox upload flow). With the new staged-files page covering the Vercel Blob handshake half, "Upload Files" was ambiguous — "Commit Files" matches what the endpoint actually does. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Stage as a verb (matches Commit Files) reads more naturally than the adjective form, and Get File matches the GET method. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Matches the existing /api/sandboxes/file noun pattern. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Endpoint stays /api/sandboxes/staged-file (noun); docs filenames are verb-shaped because the HTTP method is not in the path (parallel: commit-files.mdx for POST /api/sandboxes/files). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The /api/sandboxes/files endpoint accepts any URL but its cleanup step assumes Vercel Blob — the two endpoints are coupled in a way that doesn't justify locking in commit/stage semantics in the docs yet. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Verb-noun shape parallels stage-file and get-file. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Pairs with the api-side change to hide raw exception details and return a generic 500. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
a0e7fe1 to
9d79852CompareUh oh!
There was an error while loading. Please reload this page.
Summary
Documents the new sandbox staged-files token-handshake endpoint that pairs with api#541. Adds an OpenAPI entry under
content.json, a frontmatter-only MDX page, and the sandboxes nav slot indocs.json.Test plan
python3 -m json.toolclean onapi-reference/openapi/content.jsonanddocs.jsonnpx mintlify@latest dev— verify the new "Stage Files" page renders under SandboxesSummary by cubic
Documents
POST /api/sandboxes/staged-filefor the Vercel Blob client-upload handshake.OpenAPI notes
@vercel/blob/clientusage, adds a 100MB limit and 401/500 responses, adds a Stage File page (stage-file.mdx), renames Upload→Upload Files and File→Get File, and updates the Sandboxes nav.Written for commit 9d79852. Summary will update on new commits.
Summary by CodeRabbit