Skip to content

Clarify snippet body parameters and file requirements - #33440

Open
jed wants to merge 1 commit into
cloudflare:productionfrom
jed:patch-1
Open

jed wants to merge 1 commit into
cloudflare:productionfrom
jed:patch-1

Conversation

@jed

@jed jed commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Updated snippet requirements to clarify file handling and ES module usage.

Summary

The Snippets upload API is superficially identical to the Workers API, but unlike Workers, does not support uploading non-ESM files. This change reflects this in the documentation.

Documentation checklist

Updated snippet requirements to clarify file handling and ES module usage.
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Review

💡 2 suggestions found in commit 41bf281.

👉 Fix in your agent 👈
Fix the following review findings in PR #33440 (https://github.com/cloudflare/cloudflare-docs/pull/33440).

Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
  or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order

After triaging, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.

The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.

---

## Style Guide Review

### Suggestions (2)

#### SG-903d2566fba9 · Bullet list with fewer than three items
- **File:** `src/content/docs/rules/snippets/create-api.mdx` line 71
- **Issue:** The `files`/`metadata` bullet list contains only two items
- **Fix:** Consider writing the two parameters as prose instead of a bullet list, or expand the list with additional items

#### SG-34f2c1963a21 · Passive voice
- **File:** `src/content/docs/rules/snippets/create-api.mdx` line 71
- **Issue:** `non-ESM files such as JSON, text, binary, or WebAssembly files are not supported and are rejected when you upload them`
- **Fix:** Rewrite in active voice, for example: `Cloudflare does not support non-ESM files such as JSON, text, binary, or WebAssembly files and rejects them when you upload them.`

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

No convention issues found.

Style Guide Review

Suggestions (2)
File Issue
rules/snippets/create-api.mdx line 71 Bullet list with fewer than three items — The files/metadata bullet list contains only two items Fix: Consider writing the two parameters as prose instead of a bullet list, or expand the list with additional items
rules/snippets/create-api.mdx line 71 Passive voicenon-ESM files such as JSON, text, binary, or WebAssembly files are not supported and are rejected when you upload them Fix: Rewrite in active voice, for example: Cloudflare does not support non-ESM files such as JSON, text, binary, or WebAssembly files and rejects them when you upload them.
Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.
/rebase Rebases the PR branch against production. On conflict, attempts to resolve automatically using AI. Stops with an explanation if confidence is not high enough.

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

Labels

product:rules Related to rules size/xs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants