Skip to content

Commit 7abc353

Browse files
committed
Add links in signal and signal-with-start responses
1 parent 43b4618 commit 7abc353

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
@@ -16421,11 +16421,21 @@
1642116421
"started": {
1642216422
"type": "boolean",
1642316423
"description": "If true, a new workflow was started."
16424+
},
16425+
"link": {
16426+
"$ref": "#/definitions/v1Link",
16427+
"description": "Link to be associated with the WorkflowExecutionSignaled event.\nAdded on the response to propagate the backlink."
1642416428
}
1642516429
}
1642616430
},
1642716431
"v1SignalWorkflowExecutionResponse": {
16428-
"type": "object"
16432+
"type": "object",
16433+
"properties": {
16434+
"link": {
16435+
"$ref": "#/definitions/v1Link",
16436+
"description": "Link to be associated with the WorkflowExecutionSignaled event.\nAdded on the response to propagate the backlink."
16437+
}
16438+
}
1642916439
},
1643016440
"v1StartActivityExecutionResponse": {
1643116441
"type": "object",

openapi/openapiv3.yaml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14136,6 +14136,12 @@ components:
1413614136
started:
1413714137
type: boolean
1413814138
description: If true, a new workflow was started.
14139+
link:
14140+
allOf:
14141+
- $ref: '#/components/schemas/Link'
14142+
description: |-
14143+
Link to be associated with the WorkflowExecutionSignaled event.
14144+
Added on the response to propagate the backlink.
1413914145
SignalWorkflowExecutionRequest:
1414014146
type: object
1414114147
properties:
@@ -14176,7 +14182,13 @@ components:
1417614182
- temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
1417714183
SignalWorkflowExecutionResponse:
1417814184
type: object
14179-
properties: {}
14185+
properties:
14186+
link:
14187+
allOf:
14188+
- $ref: '#/components/schemas/Link'
14189+
description: |-
14190+
Link to be associated with the WorkflowExecutionSignaled event.
14191+
Added on the response to propagate the backlink.
1418014192
StartActivityExecutionRequest:
1418114193
type: object
1418214194
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 link = 3;
868874
}
869875

870876
message ResetWorkflowExecutionRequest {

0 commit comments

Comments
 (0)