Repository navigation
Conversation
The envelope is what a stream provider writes and reads, so every language decodes the same bytes. The server stores it as is and never interprets it.
This was referenced Oct 6, 2026
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.
This PR adds the stream record envelope to the public API.
What changed?
temporal/api/stream/v1package withStreamRecordandStreamRecordKind.StreamRecordKindhasDATAfor a published value andFINISHfor a producer that's done on a topic.openapi/, the Nexus yaml and the system Nexus WIT don't change.bodycomment only says what the field holds and who applies a codec.Part of AI-198 (epic AI-37).
Why?
The SDK streaming interface lets different stream providers plug in under one reader and writer. The envelope is what a provider writes and reads. Having it in the api means a record written from Python decodes the same in Go or Rust, and in any store. The server never interprets it.
It now sits right on
main. The earlier version stacked on the two notification channel PRs, which are paused per the 2026-10-05 design review. The envelope never depended on them.How did you test it?
Link to a test plan if any -
make buf-lintandmake api-linterare clean, andbuf breakingagainst upstreammainpasses.make http-api-docs,nexus-rpc-yamlandsystem-nexus-witleave the tree as is. The Python PRs in the series use the envelope through the memory, Workflow Streams and Redis providers.