Design doc: SSE (text/event-stream) framing for event streams#3229
Open
goelakash wants to merge 2 commits into
Open
Design doc: SSE (text/event-stream) framing for event streams#3229goelakash wants to merge 2 commits into
goelakash wants to merge 2 commits into
Conversation
Contributor
|
This pull request does not contain a staged changelog entry. To create one, use the Make sure that the description is appropriate for a changelog entry and that the proper feature type is used. See |
Proposes smithy.protocols#sseJson, a protocol that frames response event streams as Server-Sent Events (text/event-stream) with JSON event payloads, reusing the existing @streaming union model.
goelakash
force-pushed
the
sse-event-streams-design
branch
from
July 24, 2026 01:02
d1f10fc to
1b7d88e
Compare
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.
Issue #, if available: #3222 (discussion: #3221)
Description of changes:
Design proposal for
smithy.protocols#sseJson: framing response event streams as Server-Sent Events (text/event-stream) with JSON payloads, reusing the existing@streamingunion model unchanged. Motivated by agent/LLM services (AG-UI, MCP, OpenAI-style APIs) whose browser clients can't consumeapplication/vnd.amazon.eventstream.Opening as a draft for design discussion.
References
itemSchemafor sequential media types: https://spec.openapis.org/oas/v3.2.0.html#media-type-object (added in v3.2: Sequential/streaming media types (take 2) OAI/OpenAPI-Specification#4554)By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.