Skip to content

Commit 168fcbb

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

3 files changed

Lines changed: 30 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."
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."
16560+
}
16561+
}
1655216562
},
1655316563
"v1StartActivityExecutionResponse": {
1655416564
"type": "object",

openapi/openapiv3.yaml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14165,6 +14165,12 @@ 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.
1416814174
SignalWorkflowExecutionRequest:
1416914175
type: object
1417014176
properties:
@@ -14205,7 +14211,13 @@ components:
1420514211
- temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
1420614212
SignalWorkflowExecutionResponse:
1420714213
type: object
14208-
properties: {}
14214+
properties:
14215+
link:
14216+
allOf:
14217+
- $ref: '#/components/schemas/Link'
14218+
description: |-
14219+
Link to be associated with the WorkflowExecutionSignaled event.
14220+
Added on the response to propagate the backlink.
1420914221
StartActivityExecutionRequest:
1421014222
type: object
1421114223
properties:

temporal/api/workflowservice/v1/request_response.proto

Lines changed: 6 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,9 @@ 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;
868874
}
869875

870876
message ResetWorkflowExecutionRequest {

0 commit comments

Comments
 (0)