From c7d4e90fd945990ff9a9ea98e80fd2352edee9e0 Mon Sep 17 00:00:00 2001 From: long-nt-tran Date: Wed, 8 Apr 2026 16:51:16 -0400 Subject: [PATCH] Add links in signal and signal-with-start responses --- openapi/openapiv2.json | 12 +++++++++++- openapi/openapiv3.yaml | 16 +++++++++++++++- .../workflowservice/v1/request_response.proto | 8 ++++++++ 3 files changed, 34 insertions(+), 2 deletions(-) diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index dfaa2618c..85c742310 100644 --- a/openapi/openapiv2.json +++ b/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", diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index fe637190c..f849388b9 100644 --- a/openapi/openapiv3.yaml +++ b/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: diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto index 8580b7179..903fad7ea 100644 --- a/temporal/api/workflowservice/v1/request_response.proto +++ b/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 {