Add links in signal and signal-with-start responses

Author: long-nt-tran

openapi/openapiv2.json

@@ -16544,11 +16544,21 @@
         "started": {
           "type": "boolean",
           "description": "If true, a new workflow was started."
+        },
+        "signalLink": {
+          "$ref": "#/definitions/v1Link",
+          "description": "Link to be associated with the WorkflowExecutionSignaled event.\nAdded on the response to propagate the backlink.\nAvailable from Temporal server 1.31 and up."
         }
       }
     },
     "v1SignalWorkflowExecutionResponse": {
-      "type": "object"
+      "type": "object",
+      "properties": {
+        "link": {
+          "$ref": "#/definitions/v1Link",
+          "description": "Link to be associated with the WorkflowExecutionSignaled event.\nAdded on the response to propagate the backlink.\nAvailable from Temporal server 1.31 and up."
+        }
+      }
     },
     "v1StartActivityExecutionResponse": {
       "type": "object",
@@ -18467,6 +18477,10 @@
         "externalWorkflowExecution": {
           "$ref": "#/definitions/v1WorkflowExecution",
           "description": "When signal origin is a workflow execution, this field is set."
+        },
+        "requestId": {
+          "type": "string",
+          "description": "The request ID of the Signal request, used by the server to attach this to\nthe correct Event ID when generating link."
         }
       }
     },

openapi/openapiv3.yaml

@@ -14165,6 +14165,13 @@ components:
         started:
           type: boolean
           description: If true, a new workflow was started.
+        signalLink:
+          allOf:
+            - $ref: '#/components/schemas/Link'
+          description: |-
+            Link to be associated with the WorkflowExecutionSignaled event.
+             Added on the response to propagate the backlink.
+             Available from Temporal server 1.31 and up.
     SignalWorkflowExecutionRequest:
       type: object
       properties:
@@ -14205,7 +14212,14 @@ components:
            - temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
     SignalWorkflowExecutionResponse:
       type: object
-      properties: {}
+      properties:
+        link:
+          allOf:
+            - $ref: '#/components/schemas/Link'
+          description: |-
+            Link to be associated with the WorkflowExecutionSignaled event.
+             Added on the response to propagate the backlink.
+             Available from Temporal server 1.31 and up.
     StartActivityExecutionRequest:
       type: object
       properties:
@@ -17115,6 +17129,11 @@ components:
           allOf:
             - $ref: '#/components/schemas/WorkflowExecution'
           description: When signal origin is a workflow execution, this field is set.
+        requestId:
+          type: string
+          description: |-
+            The request ID of the Signal request, used by the server to attach this to
+             the correct Event ID when generating link.
     WorkflowExecutionStartedEventAttributes:
       type: object
       properties:

temporal/api/history/v1/message.proto

@@ -604,6 +604,9 @@ message WorkflowExecutionSignaledEventAttributes {
     bool skip_generate_workflow_task = 5 [deprecated = true];
     // When signal origin is a workflow execution, this field is set.
     temporal.api.common.v1.WorkflowExecution external_workflow_execution = 6;
+    // The request ID of the Signal request, used by the server to attach this to
+    // the correct Event ID when generating link.
+    string request_id = 7;
 }
 
 message WorkflowExecutionTerminatedEventAttributes {

temporal/api/workflowservice/v1/request_response.proto

@@ -793,6 +793,10 @@ message SignalWorkflowExecutionRequest {
 }
 
 message SignalWorkflowExecutionResponse {
+    // Link to be associated with the WorkflowExecutionSignaled event.
+    // Added on the response to propagate the backlink.
+    // Available from Temporal server 1.31 and up.
+    temporal.api.common.v1.Link link = 1;
 }
 
 message SignalWithStartWorkflowExecutionRequest {
@@ -865,6 +869,10 @@ message SignalWithStartWorkflowExecutionResponse {
     string run_id = 1;
     // If true, a new workflow was started.
     bool started = 2;
+    // Link to be associated with the WorkflowExecutionSignaled event.
+    // Added on the response to propagate the backlink.
+    // Available from Temporal server 1.31 and up.
+    temporal.api.common.v1.Link signal_link = 3;
 }
 
 message ResetWorkflowExecutionRequest {