AsyncAPI WebSocket Playground doesn't display binary frame messages #2638
bakharew
started this conversation in
Bugs & Feedback
Replies: 1 comment
-
AsyncAPI Spec NoteThe AsyncAPI WebSocket Message Bindings currently state: "This object MUST NOT contain any properties. Its name is reserved for future use." This means there's no AsyncAPI-level way to specify binary vs text frame type. Since AsyncAPI doesn't distinguish between frame types, Mintlify should handle binary frames containing valid UTF-8 JSON gracefully by default. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
AsyncAPI WebSocket Playground doesn't display binary frame messages
Description
The AsyncAPI WebSocket playground correctly connects and receives messages, but displays
{}for incoming messages sent as binary WebSocket frames, even when the content is valid UTF-8 encoded JSON.Steps to Reproduce
ws.send_bytes(json.dumps(message).encode("utf-8"))){}Expected Behavior
Binary frames containing UTF-8 encoded JSON should be decoded and displayed in the playground, similar to how text frames are handled.
Actual Behavior
ws.send_str(json.dumps(message))) → Displayed correctly ✅ws.send_bytes(json.dumps(message).encode("utf-8"))) → Shows{}❌Verification
Switching the backend from
send_bytes()tosend_str()immediately fixes the display issue, confirming the playground receives the data but doesn't decode binary frames.Environment
contentType: application/jsonspecified in the message schemaContext
This is how Google's Gemini Live API sends their WebSocket stream messages (binary frames with UTF-8 JSON), so supporting binary frame decoding is highly relevant for documenting real-world APIs.
Beta Was this translation helpful? Give feedback.
All reactions