[Fix #1151] Replace output with outputUri in lifecycle completed events#1172
Open
ricardozanini wants to merge 6 commits into
Open
Conversation
…in lifecycle completed events Replace the output map property with an outputUri in both Workflow Completed and Task Completed lifecycle events. This adopts the Claim Check pattern to avoid exceeding CloudEvents 64KB size limits. Signed-off-by: Ricardo Zanini <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the lifecycle event documentation to stop embedding potentially large output payloads in Workflow Completed and Task Completed events, replacing them with an outputUri reference aligned with the Claim Check pattern to avoid CloudEvents size-limit issues.
Changes:
- Replaces
output(map) withoutputUri(uri) for Workflow Completed event properties and example. - Replaces
output(map) withoutputUri(uri) for Task Completed event properties and example.
Comments suppressed due to low confidence (1)
dsl-reference.md:1641
- Same as above: this description suggests output could still be embedded ("instead of embedding the output directly"), but the spec here removes the embedded
outputfield. Rephrase to explicitly describe the Claim Check intent (reference-only) to avoid confusion for implementers.
| outputUri | `uri` | `no` | A URI pointing to the task's output data, if any. Implementations **should** use this [Claim Check](https://www.enterpriseintegrationpatterns.com/patterns/messaging/StoreInLibrary.html) approach instead of embedding the output directly, to avoid exceeding [CloudEvents size limits](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#size-limits). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
dsl-reference.md:1641
- This text says implementations should use the Claim Check approach "instead of embedding the output directly", but
outputhas been removed from this event. Rewording to match the Workflow Completed Event phrasing would avoid implying an alternative embedding mechanism exists.
| outputUri | `uri` | `no` | A URI pointing to the task's output data, if any. Implementations **should** use this [Claim Check](https://www.enterpriseintegrationpatterns.com/patterns/messaging/StoreInLibrary.html) approach instead of embedding the output directly, to avoid exceeding [CloudEvents size limits](https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#size-limits). |
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
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.
Summary
output(map) withoutputUri(uri) in both Workflow Completed and Task Completed lifecycle eventsBreaking change
This removes the
outputproperty from completed lifecycle events. Runtime implementations must emitoutputUriinstead.Fixes #1151