docs(streaming): document WS close code 1006 as RFC-reserved client-side code#200
Merged
Conversation
…ide code Add code 1006 to the close code tables in both the WebSocket streaming guide and the WebSocket API reference, with a Callout explaining that it is never transmitted over the wire — the client WebSocket library generates it locally on abnormal TCP teardown (network loss, process kill). Developers commonly mistake it for a server-sent code; the callout surfaces this before they waste time debugging the server side. Co-Authored-By: Paperclip <noreply@paperclip.ing>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Mlaz-code
added a commit
that referenced
this pull request
May 7, 2026
…ide code (#200) Add code 1006 to the close code tables in both the WebSocket streaming guide and the WebSocket API reference, with a Callout explaining that it is never transmitted over the wire — the client WebSocket library generates it locally on abnormal TCP teardown (network loss, process kill). Developers commonly mistake it for a server-sent code; the callout surfaces this before they waste time debugging the server side. Co-authored-by: root <root@api-dev.hs.chocopancake.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds close code
1006to the close-code tables in both the WebSocket streaming guide (content/en/streaming/websocket.mdx) and the WebSocket API reference (content/en/api-reference/websocket.mdx), with a Callout explaining that 1006 is never transmitted over the wire — the client WebSocket library generates it locally on abnormal TCP teardown (network loss, process kill).Developers commonly mistake 1006 for a server-sent code and waste time looking for a server-side cause. The callout surfaces the correct interpretation up front.
Origin
Authored by a parked Paperclip agent on
paperclip/SHA-217711 hours ago, never PR'd. Cherry-picked onto a fresh branch offorigin/main. The dirtypublic/openapi.jsonregen and stray~/in that worktree were excluded.Test plan
1006 (Abnormal Closure)in their close-code tables🤖 Generated with Claude Code