Skip to content

Commit c7d4e90

Browse files
committed
Add links in signal and signal-with-start responses
1 parent 6f298e7 commit c7d4e90

3 files changed

Lines changed: 34 additions & 2 deletions

File tree

openapi/openapiv2.json

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16544,11 +16544,21 @@
1654416544
"started": {
1654516545
"type": "boolean",
1654616546
"description": "If true, a new workflow was started."
16547+
},
16548+
"signalLink": {
16549+
"$ref": "#/definitions/v1Link",
16550+
"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."
1654716551
}
1654816552
}
1654916553
},
1655016554
"v1SignalWorkflowExecutionResponse": {
16551-
"type": "object"
16555+
"type": "object",
16556+
"properties": {
16557+
"link": {
16558+
"$ref": "#/definitions/v1Link",
16559+
"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."
16560+
}
16561+
}
1655216562
},
1655316563
"v1StartActivityExecutionResponse": {
1655416564
"type": "object",

openapi/openapiv3.yaml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14165,6 +14165,13 @@ components:
1416514165
started:
1416614166
type: boolean
1416714167
description: If true, a new workflow was started.
14168+
signalLink:
14169+
allOf:
14170+
- $ref: '#/components/schemas/Link'
14171+
description: |-
14172+
Link to be associated with the WorkflowExecutionSignaled event.
14173+
Added on the response to propagate the backlink.
14174+
Available from Temporal server 1.31 and up.
1416814175
SignalWorkflowExecutionRequest:
1416914176
type: object
1417014177
properties:
@@ -14205,7 +14212,14 @@ components:
1420514212
- temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
1420614213
SignalWorkflowExecutionResponse:
1420714214
type: object
14208-
properties: {}
14215+
properties:
14216+
link:
14217+
allOf:
14218+
- $ref: '#/components/schemas/Link'
14219+
description: |-
14220+
Link to be associated with the WorkflowExecutionSignaled event.
14221+
Added on the response to propagate the backlink.
14222+
Available from Temporal server 1.31 and up.
1420914223
StartActivityExecutionRequest:
1421014224
type: object
1421114225
properties:

temporal/api/workflowservice/v1/request_response.proto

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -793,6 +793,10 @@ message SignalWorkflowExecutionRequest {
793793
}
794794

795795
message SignalWorkflowExecutionResponse {
796+
// Link to be associated with the WorkflowExecutionSignaled event.
797+
// Added on the response to propagate the backlink.
798+
// Available from Temporal server 1.31 and up.
799+
temporal.api.common.v1.Link link = 1;
796800
}
797801

798802
message SignalWithStartWorkflowExecutionRequest {
@@ -865,6 +869,10 @@ message SignalWithStartWorkflowExecutionResponse {
865869
string run_id = 1;
866870
// If true, a new workflow was started.
867871
bool started = 2;
872+
// Link to be associated with the WorkflowExecutionSignaled event.
873+
// Added on the response to propagate the backlink.
874+
// Available from Temporal server 1.31 and up.
875+
temporal.api.common.v1.Link signal_link = 3;
868876
}
869877

870878
message ResetWorkflowExecutionRequest {

0 commit comments

Comments
 (0)