Skip to content

Add completion callbacks to SignalWithStart request #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pdoerner wants to merge 1 commit into from
Closed

Add completion callbacks to SignalWithStart request #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6367,6 +6367,14 @@
"versioningOverride": {
"$ref": "#/definitions/v1VersioningOverride",
"description": "If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.\nTo unset the override after the workflow is running, use UpdateWorkflowExecutionOptions."
},
"completionCallbacks": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1Callback"
},
"description": "Callbacks to be called by the server when this workflow reaches a terminal state.\nIf the workflow continues-as-new, these callbacks will be carried over to the new execution.\nCallbacks will not be deduplicated if the workflow is already started with callbacks.\nCallback addresses must be whitelisted in the server's dynamic configuration."
}
}
},
Expand Down
9 changes: 9 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9063,6 +9063,15 @@ components:
description: |-
If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
completionCallbacks:
type: array
items:
$ref: '#/components/schemas/Callback'
description: |-
Callbacks to be called by the server when this workflow reaches a terminal state.
If the workflow continues-as-new, these callbacks will be carried over to the new execution.
Callbacks will not be deduplicated if the workflow is already started with callbacks.
Callback addresses must be whitelisted in the server's dynamic configuration.
SignalWithStartWorkflowExecutionResponse:
type: object
properties:
Expand Down
5 changes: 5 additions & 0 deletions temporal/api/workflowservice/v1/request_response.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,6 +754,11 @@ message SignalWithStartWorkflowExecutionRequest {
// If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
// To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
temporal.api.workflow.v1.VersioningOverride versioning_override = 25;
// Callbacks to be called by the server when this workflow reaches a terminal state.
// If the workflow continues-as-new, these callbacks will be carried over to the new execution.
// Callbacks will not be deduplicated if the workflow is already started with callbacks.
Copy link
Member

@cretz cretz Jan 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens to this list when a workflow already exists? Is it discarded like it is for other start calls that don't start a workflow? Can we accept OnConflictOptions from #510 to be clear what side effecting action is taken on already-existing workflows?

// Callback addresses must be whitelisted in the server's dynamic configuration.
repeated temporal.api.common.v1.Callback completion_callbacks = 26;
}

message SignalWithStartWorkflowExecutionResponse {
Expand Down
Loading