docs(websocket): mark sharpapi-v1.5 as internal-only#204
Merged
Conversation
The MessagePack subprotocol is reserved for first-party SDKs and SharpLines — it isn't part of the documented public API. Listing it in the public asyncapi spec led a customer-support agent to recommend it to a customer debugging unrelated 60s WS disconnects (already fixed server-side in sharp-api-go PR #177). Removes v1.5 from the public table and replaces the explanatory paragraph with a note that additional subprotocols exist but are not public. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
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
The MessagePack subprotocol is reserved for first-party SDKs and SharpLines — it isn't part of the documented public API. Listing it in the public asyncapi spec led a customer-support agent to recommend it to a customer debugging unrelated 60s WS disconnects (already fixed server-side in sharp-api-go PR #177). Removes v1.5 from the public table and replaces the explanatory paragraph with a note that additional subprotocols exist but are not public. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
sharpapi-v1.5from the public subprotocol table inpublic/asyncapi.yamlsharpapi-v1Why
The MessagePack subprotocol is internal-only — only
/root/sharp-lines/(our sister product) negotiates it, and the cross-repo audit on 2026-04-22 explicitly tagged itNOT APPLICABLEfor public docs. Today a customer-support agent (Maya) recommended it to a customer debugging unrelated 60s WS disconnects (already fixed server-side in sharp-api-go PR #177 / SHA-2188), citing this asyncapi spec as the source. Removing the public reference closes the leak.No code change in sharp-api-go — the server still accepts both subprotocols on the wire (and will continue to, for the internal SDK and SharpLines). This is a docs-only correction.
Test plan
sharpapi-v1)🤖 Generated with Claude Code