Repository navigation
docs: retrieve externally stored payloads when they are decoded - #931
Merged
Merged
Conversation
dplyukhin
approved these changes
Oct 29, 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
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.
What changed
Adds a "When to retrieve" subsection to the Retrieval section of the external storage spec. An SDK retrieves a payload when it decodes it, not when the response carrying it arrives. A payload that is never decoded is never retrieved, and a raw payload is handed to the caller as the server sent it. A worker follows the same rule for a whole task: it decodes the whole task before running it, so it retrieves the whole task first.
The opening sentence of the Retrieval section now says retrieval runs when an SDK decodes payloads, not when it receives them.
Why
Describe and list responses carry payloads that callers often never read, such as memo fields, inputs, heartbeat details and schedule action arguments. An SDK that retrieves the whole response on arrival gets both cases wrong:
TMPRL1105, so the caller can't even list its workflows.This came up when implementing each SDK and was re-derived each time.