Skip to content

Commit 5c99d1b

Browse files
committed
Add links in signal and signal-with-start responses
1 parent 67150b1 commit 5c99d1b

3 files changed

Lines changed: 40 additions & 2 deletions

File tree

openapi/openapiv2.json

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16426,11 +16426,25 @@
1642616426
"started": {
1642716427
"type": "boolean",
1642816428
"description": "If true, a new workflow was started."
16429+
},
16430+
"signalLink": {
16431+
"$ref": "#/definitions/v1Link",
16432+
"description": "Link to be associated with the WorkflowExecutionSignaled event.\nAdded on the response to propagate the backlink."
16433+
},
16434+
"workflowStartLink": {
16435+
"$ref": "#/definitions/v1Link",
16436+
"description": "Workflow start link to be associated with the WorkflowExecutionStarted event."
1642916437
}
1643016438
}
1643116439
},
1643216440
"v1SignalWorkflowExecutionResponse": {
16433-
"type": "object"
16441+
"type": "object",
16442+
"properties": {
16443+
"link": {
16444+
"$ref": "#/definitions/v1Link",
16445+
"description": "Link to be associated with the WorkflowExecutionSignaled event.\nAdded on the response to propagate the backlink."
16446+
}
16447+
}
1643416448
},
1643516449
"v1StartActivityExecutionResponse": {
1643616450
"type": "object",

openapi/openapiv3.yaml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14155,6 +14155,16 @@ components:
1415514155
started:
1415614156
type: boolean
1415714157
description: If true, a new workflow was started.
14158+
signalLink:
14159+
allOf:
14160+
- $ref: '#/components/schemas/Link'
14161+
description: |-
14162+
Link to be associated with the WorkflowExecutionSignaled event.
14163+
Added on the response to propagate the backlink.
14164+
workflowStartLink:
14165+
allOf:
14166+
- $ref: '#/components/schemas/Link'
14167+
description: Workflow start link to be associated with the WorkflowExecutionStarted event.
1415814168
SignalWorkflowExecutionRequest:
1415914169
type: object
1416014170
properties:
@@ -14195,7 +14205,13 @@ components:
1419514205
- temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
1419614206
SignalWorkflowExecutionResponse:
1419714207
type: object
14198-
properties: {}
14208+
properties:
14209+
link:
14210+
allOf:
14211+
- $ref: '#/components/schemas/Link'
14212+
description: |-
14213+
Link to be associated with the WorkflowExecutionSignaled event.
14214+
Added on the response to propagate the backlink.
1419914215
StartActivityExecutionRequest:
1420014216
type: object
1420114217
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,9 @@ 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+
temporal.api.common.v1.Link link = 1;
796799
}
797800

798801
message SignalWithStartWorkflowExecutionRequest {
@@ -865,6 +868,11 @@ message SignalWithStartWorkflowExecutionResponse {
865868
string run_id = 1;
866869
// If true, a new workflow was started.
867870
bool started = 2;
871+
// Link to be associated with the WorkflowExecutionSignaled event.
872+
// Added on the response to propagate the backlink.
873+
temporal.api.common.v1.Link signal_link = 3;
874+
// Workflow start link to be associated with the WorkflowExecutionStarted event.
875+
temporal.api.common.v1.Link workflow_start_link = 4;
868876
}
869877

870878
message ResetWorkflowExecutionRequest {

0 commit comments

Comments
 (0)