Skip to content

Conversation

@agents-git-bot
Copy link
Contributor

@agents-git-bot agents-git-bot bot commented Jan 7, 2026

Documents the new prefix parameter for mountBucket() that allows mounting S3 bucket subdirectories.

Changes

  • Added API reference documentation for the prefix option in MountBucketOptions
  • Added usage example in the storage API reference
  • Added dedicated section in the mount-buckets guide with examples
  • Updated best practices to recommend using prefixes for dataset isolation

Sync Details

Feature Summary

The prefix option enables mounting a specific subdirectory within a bucket. When specified:

  • Only contents under the prefix are visible at the mount point
  • Must start and end with / (e.g., /uploads/images/)
  • Validated by validatePrefix() function in the SDK

Example

// Mount only /uploads/images/ subdirectory
await sandbox.mountBucket('my-bucket', '/images', {
  endpoint: 'https://YOUR_ACCOUNT_ID.r2.cloudflarestorage.com',
  prefix: '/uploads/images/'
});

Add documentation for the new prefix option in mountBucket() that allows
mounting specific subdirectories within S3-compatible buckets.

Changes:
- Add prefix field to MountBucketOptions type documentation
- Add example of mounting bucket subdirectory in API reference
- Add dedicated section in mount-buckets guide with multiple examples
- Document prefix format requirements (must start and end with /)

Related: cloudflare/sandbox-sdk#335
Documents the new prefix parameter that allows mounting S3 bucket
subdirectories. Updates both the API reference and mount-buckets guide
with examples and validation requirements.

Syncs cloudflare-docs with sandbox-sdk PR #335
@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/sandbox/ @whoiskatrin, @ghostwriternr, @cloudflare/pcx-technical-writing, @cloudflare/ai-agents

@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

CI run failed: build logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants