Conversation
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
| | Error Code | HTTP Status | Details | Recommended actions | | ||
| | ---------- | ------------------------ | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | ||
| | 10104 | QueueNotFound | Queue does not exist | Check for existence of `queue_id` in [List Queues endpoint](/api/resources/queues/) | | ||
| | 10105 | FeatureFlagNotSet | Feature flag not set | Ensure that feature flag is set past `February 17, 2026` compatibility date | |
There was a problem hiding this comment.
We don't really call the feature flag middleware ATM so we wont be hitting this error.
There was a problem hiding this comment.
Based on @tgarg-cf's feedback that this error is not currently reachable, I suggest removing this row or marking it as reserved/internal. Here's a suggestion to remove it:
| | 10105 | FeatureFlagNotSet | Feature flag not set | Ensure that feature flag is set past `February 17, 2026` compatibility date | | |
| | 10104 | QueueNotFound | Queue does not exist | Check for existence of `queue_id` in [List Queues endpoint](/api/resources/queues/) | |
Alternatively, if you want to keep it documented for future use, consider adding a note that this error code is reserved and not currently returned.
|
/bonk review this, and where the user tgarg has comments, provide suggestions using the gh CLI suggestion syntax. |
There was a problem hiding this comment.
Review Summary
I have posted suggestion replies to all of @tgarg-cf's comments above. Beyond those, here are additional issues I found in this PR:
Issues in the code example (lines 14-22)
- Line 16: Syntax error in the example code —
"message,"should be"message",(the comma is inside the string instead of outside it). - Line 20: Mixed quotes — the string starts with a single quote
'but ends with a backtick. Also, "messag" is a typo and should be "message". - Line 17: Inconsistent indentation — uses spaces while the rest of the block uses tabs.
Incorrect link in the intro (line 8)
The intro says "error codes returned by Queues when using the Workers API" but links to /r2/api/workers/ (the R2 Workers API). This should either link to the Queues JavaScript API page (/queues/configuration/javascript-apis/) or be reworded since the page covers both the JS binding API and the HTTP API.
Missing description in frontmatter
The frontmatter is missing a description field, which is recommended for SEO.
Code block on line 26 missing language
The second code block (the JSON response example) uses bare triple backticks with no language. Per the style guide, always specify a language — this should be json.
Table formatting issues (line 67)
The 429 errors table has an extra trailing | --- | column in the header separator and extra | | cells on the QueueDisabled row (line 70). This creates a phantom empty column.
Remaining ?? placeholders
Lines 55 (ClientDisconnected) and 68 (QueueOverloaded) still have ?? as recommended actions. These should be filled in before merging.
"HTTP Status" column is actually the error name
The column header says "HTTP Status" but the values are internal error names like QueueNotFound, Unauthorized, etc. Consider renaming to "Error Name" or "Error Type" and adding an actual HTTP status code column (e.g., 400, 404, 429, 500).
|
Done. Here's a summary of everything posted to PR #28402: Suggestions posted in reply to @tgarg-cf's comments
Additional issues flagged in the review summary
|
| | 10204 | MessageSizeOutOfBounds | Message size out of bounds | Ensure that message size is within 0 and 128 KB | | ||
| | 10205 | BatchSizeOutOfBounds | Batch size out of bounds | Ensure that batch size is within 0 and 256 KB | | ||
| | 10206 | BatchCountOutOfBounds | Batch count out of bounds | Ensure that batch count is within 0 and 100 messages | | ||
| | 10207 | JSONRequestBodyInvalid | API Gateway request JSON body does not match expected schema | Ensure that JSON body matches the expected schema | |
| | 10205 | BatchSizeOutOfBounds | Batch size out of bounds | Ensure that batch size is within 0 and 256 KB | | ||
| | 10206 | BatchCountOutOfBounds | Batch count out of bounds | Ensure that batch count is within 0 and 100 messages | | ||
| | 10207 | JSONRequestBodyInvalid | API Gateway request JSON body does not match expected schema | Ensure that JSON body matches the expected schema | | ||
| | 10208 | JSONRequestBodyMalformed | API Gateway request body is not valid JSON | REST API request body is not valid. Look at error message for additional details. | |
Summary
Adding error codes which are now surfaced off Queues API
Documentation checklist