Add Callbacks and Links to Workflow Update

openapi/openapiv3.yaml

@@ -8776,6 +8776,14 @@ components:
       properties:
         workflowClosed:
           $ref: '#/components/schemas/CallbackInfo_WorkflowClosed'
+        updateWorkflowExecutionCompleted:
+          $ref: '#/components/schemas/CallbackInfo_UpdateWorkflowExecutionCompleted'
+    CallbackInfo_UpdateWorkflowExecutionCompleted:
+      type: object
+      properties:
+        updateId:
+          type: string
+      description: Trigger for when a workflow update is completed.
     CallbackInfo_WorkflowClosed:
       type: object
       properties: {}
@@ -12082,6 +12090,19 @@ components:
           $ref: '#/components/schemas/Meta'
         input:
           $ref: '#/components/schemas/Input'
+        requestId:
+          type: string
+          description: The request ID of the request.
+        completionCallbacks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Callback'
+          description: Callbacks to be called by the server when this update reaches a terminal state.
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+          description: Links to be associated with this update.
       description: The client request that triggers a Workflow Update.
     RequestCancelActivityExecutionRequest:
       type: object
@@ -15039,6 +15060,10 @@ components:
              request WaitPolicy, and before the context deadline expired; clients may
              may then retry the call as needed.
           format: enum
+        link:
+          allOf:
+            - $ref: '#/components/schemas/Link'
+          description: Link to the update event. May be null if the update has not yet been accepted.
     UpsertWorkflowSearchAttributesEventAttributes:
       type: object
       properties:
@@ -16309,6 +16334,17 @@ components:
           description: |-
             Priority override upserted in this event. Represents the full priority; not just partial fields.
              Ignored if nil.
+        workflowUpdateOptions:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/WorkflowExecutionOptionsUpdatedEventAttributes_WorkflowUpdateOptionsUpdate'
+    WorkflowExecutionOptionsUpdatedEventAttributes_WorkflowUpdateOptionsUpdate:
+      type: object
+      properties:
+        attachedCompletionCallbacks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Callback'
     WorkflowExecutionPauseInfo:
       type: object
       properties:
@@ -16666,6 +16702,13 @@ components:
           description: |-
             The message payload of the original request message that initiated this
              update.
+        completionCallbacks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Callback'
+          description: |-
+            Completion callbacks attached when this update was started.
+             TODO(quinn) maybe not needed
     WorkflowExecutionUpdateAdmittedEventAttributes:
       type: object
       properties:

temporal/api/history/v1/message.proto

@@ -858,6 +858,13 @@ message ChildWorkflowExecutionTerminatedEventAttributes {
 }
 
 message WorkflowExecutionOptionsUpdatedEventAttributes {
+    message WorkflowUpdateOptionsUpdate {
+        // Request ID attached to the running workflow update so that subsequent requests with same
+        // request ID will be deduped
+        string attached_request_id = 3;
+        // Completion callbacks attached to the running workflow update.
+        repeated temporal.api.common.v1.Callback attached_completion_callbacks = 1;
+    }
     // Versioning override upserted in this event.
     // Ignored if nil or if unset_versioning_override is true.
     temporal.api.workflow.v1.VersioningOverride versioning_override = 1;
@@ -873,6 +880,8 @@ message WorkflowExecutionOptionsUpdatedEventAttributes {
     // Priority override upserted in this event. Represents the full priority; not just partial fields.
     // Ignored if nil.
     temporal.api.common.v1.Priority priority = 6;
+
+    map<string, WorkflowUpdateOptionsUpdate> workflow_update_options = 7;
 }
 
 // Not used anywhere. Use case is replaced by WorkflowExecutionOptionsUpdatedEventAttributes
@@ -909,6 +918,9 @@ message WorkflowExecutionUpdateAcceptedEventAttributes {
     // The message payload of the original request message that initiated this
     // update.
     temporal.api.update.v1.Request accepted_request = 4;
+    // Completion callbacks attached when this update was started.
+    // TODO(quinn) maybe not needed
+    repeated temporal.api.common.v1.Callback completion_callbacks = 5;
 }
 
 message WorkflowExecutionUpdateCompletedEventAttributes {

temporal/api/update/v1/message.proto

@@ -62,6 +62,12 @@ message Input {
 message Request {
     Meta meta = 1;
     Input input = 2;
+    // The request ID of the request.
+    string request_id = 3;
+    // Callbacks to be called by the server when this update reaches a terminal state.
+    repeated temporal.api.common.v1.Callback completion_callbacks = 4;
+     // Links to be associated with this update.
+    repeated temporal.api.common.v1.Link links = 5;
 }
 
 // An Update protocol message indicating that a Workflow Update has been rejected.

temporal/api/workflow/v1/message.proto

@@ -449,9 +449,15 @@ message CallbackInfo {
     // Trigger for when the workflow is closed.
     message WorkflowClosed {}
 
+    // Trigger for when a workflow update is completed.
+    message UpdateWorkflowExecutionCompleted {
+        string update_id = 1;
+    }
+
     message Trigger {
         oneof variant {
             WorkflowClosed workflow_closed = 1;
+            UpdateWorkflowExecutionCompleted update_workflow_execution_completed = 2;
         }
     }
 

temporal/api/workflowservice/v1/request_response.proto

@@ -1733,6 +1733,9 @@ message UpdateWorkflowExecutionResponse {
     // request WaitPolicy, and before the context deadline expired; clients may
     // may then retry the call as needed.
     temporal.api.enums.v1.UpdateWorkflowExecutionLifecycleStage stage = 3;
+
+    // Link to the update event. May be null if the update has not yet been accepted.
+    temporal.api.common.v1.Link link = 4;
 }
 
 message StartBatchOperationRequest {