Skip to content

Commit 2a65140

Browse files
Shivs11Shivs11
authored
Merge branch 'master' into ss/sync_version_summary_version_state
2 parents 07dcfaa + e244d68 commit 2a65140

46 files changed

Lines changed: 282 additions & 957 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License
22

3-
Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
3+
Copyright (c) 2025 Temporal Technologies Inc. All rights reserved.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎openapi/openapiv2.json‎

Lines changed: 95 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6807,6 +6807,46 @@
68076807
}
68086808
}
68096809
},
6810+
"PostResetOperationSignalWorkflow": {
6811+
"type": "object",
6812+
"properties": {
6813+
"signalName": {
6814+
"type": "string",
6815+
"description": "The workflow author-defined name of the signal to send to the workflow."
6816+
},
6817+
"input": {
6818+
"$ref": "#/definitions/v1Payloads",
6819+
"description": "Serialized value(s) to provide with the signal."
6820+
},
6821+
"header": {
6822+
"$ref": "#/definitions/v1Header",
6823+
"description": "Headers that are passed with the signal to the processing workflow."
6824+
},
6825+
"links": {
6826+
"type": "array",
6827+
"items": {
6828+
"type": "object",
6829+
"$ref": "#/definitions/apicommonv1Link"
6830+
},
6831+
"description": "Links to be associated with the WorkflowExecutionSignaled event."
6832+
}
6833+
},
6834+
"description": "SignalWorkflow represents sending a signal after a workflow reset.\nKeep the parameter in sync with temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest."
6835+
},
6836+
"PostResetOperationUpdateWorkflowOptions": {
6837+
"type": "object",
6838+
"properties": {
6839+
"workflowExecutionOptions": {
6840+
"$ref": "#/definitions/v1WorkflowExecutionOptions",
6841+
"description": "Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask."
6842+
},
6843+
"updateMask": {
6844+
"type": "string",
6845+
"description": "Controls which fields from `workflow_execution_options` will be applied.\nTo unset a field, set it to null and use the update mask to indicate that it should be mutated."
6846+
}
6847+
},
6848+
"description": "UpdateWorkflowOptions represents updating workflow execution options after a workflow reset.\nKeep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest."
6849+
},
68106850
"StartOperationResponseAsync": {
68116851
"type": "object",
68126852
"properties": {
@@ -7329,6 +7369,14 @@
73297369
"$ref": "#/definitions/v1ResetReapplyExcludeType"
73307370
},
73317371
"title": "Event types not to be reapplied"
7372+
},
7373+
"postResetOperations": {
7374+
"type": "array",
7375+
"items": {
7376+
"type": "object",
7377+
"$ref": "#/definitions/v1PostResetOperation"
7378+
},
7379+
"title": "Operations to perform after the workflow has been reset. These operations will be applied\nto the *new* run of the workflow execution in the order they are provided.\nAll operations are applied to the workflow before the first new workflow task is generated"
73327380
}
73337381
}
73347382
},
@@ -7713,7 +7761,8 @@
77137761
},
77147762
"description": "Links to be associated with the WorkflowExecutionSignaled event."
77157763
}
7716-
}
7764+
},
7765+
"description": "Keep the parameters in sync with:\n - temporal.api.batch.v1.BatchOperationSignal.\n - temporal.api.workflow.v1.PostResetOperation.SignalWorkflow."
77177766
},
77187767
"WorkflowServiceStartBatchOperationBody": {
77197768
"type": "object",
@@ -8146,7 +8195,8 @@
81468195
"type": "string",
81478196
"description": "Controls which fields from `workflow_execution_options` will be applied.\nTo unset a field, set it to null and use the update mask to indicate that it should be mutated."
81488197
}
8149-
}
8198+
},
8199+
"description": "Keep the parameters in sync with:\n - temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions.\n - temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions."
81508200
},
81518201
"apicommonv1Link": {
81528202
"type": "object",
@@ -8775,6 +8825,14 @@
87758825
"resetReapplyType": {
87768826
"$ref": "#/definitions/v1ResetReapplyType",
87778827
"description": "History event reapply options (deprecated, use `options`)."
8828+
},
8829+
"postResetOperations": {
8830+
"type": "array",
8831+
"items": {
8832+
"type": "object",
8833+
"$ref": "#/definitions/v1PostResetOperation"
8834+
},
8835+
"title": "Operations to perform after the workflow has been reset. These operations will be applied\nto the *new* run of the workflow execution in the order they are provided.\nAll operations are applied to the workflow before the first new workflow task is generated"
87788836
}
87798837
},
87808838
"description": "BatchOperationReset sends reset requests to batch workflows.\nKeep the parameter in sync with temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest."
@@ -8875,7 +8933,7 @@
88758933
},
88768934
"workflowExecutionOptions": {
88778935
"$ref": "#/definitions/v1WorkflowExecutionOptions",
8878-
"description": "Workflow Execution options. Partial updates are accepted and controlled by update_mask."
8936+
"description": "Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask."
88798937
},
88808938
"updateMask": {
88818939
"type": "string",
@@ -8972,6 +9030,14 @@
89729030
},
89739031
"internal": {
89749032
"$ref": "#/definitions/CallbackInternal"
9033+
},
9034+
"links": {
9035+
"type": "array",
9036+
"items": {
9037+
"type": "object",
9038+
"$ref": "#/definitions/apicommonv1Link"
9039+
},
9040+
"description": "Links associated with the callback. It can be used to link to underlying resources of the\ncallback."
89759041
}
89769042
},
89779043
"description": "Callback to attach to various events in the system, e.g. workflow run completion."
@@ -10103,7 +10169,8 @@
1010310169
"$ref": "#/definitions/v1ExecuteMultiOperationResponseResponse"
1010410170
}
1010510171
}
10106-
}
10172+
},
10173+
"description": "IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination (\"Update-with-Start\") when both\n 1. the workflow update for the requested update ID has already completed, and\n 2. the workflow for the requested workflow ID has already been closed,\nthen you'll receive\n - an update response containing the update's outcome, and\n - a start response with a `status` field that reflects the workflow's current state."
1010710174
},
1010810175
"v1ExecuteMultiOperationResponseResponse": {
1010910176
"type": "object",
@@ -12114,6 +12181,18 @@
1211412181
},
1211512182
"description": "Attached to task responses to give hints to the SDK about how it may adjust its number of\npollers."
1211612183
},
12184+
"v1PostResetOperation": {
12185+
"type": "object",
12186+
"properties": {
12187+
"signalWorkflow": {
12188+
"$ref": "#/definitions/PostResetOperationSignalWorkflow"
12189+
},
12190+
"updateWorkflowOptions": {
12191+
"$ref": "#/definitions/PostResetOperationUpdateWorkflowOptions"
12192+
}
12193+
},
12194+
"description": "PostResetOperation represents an operation to be performed on the new workflow execution after a workflow reset."
12195+
},
1211712196
"v1Priority": {
1211812197
"type": "object",
1211912198
"properties": {
@@ -12214,6 +12293,10 @@
1221412293
"activityPaused": {
1221512294
"type": "boolean",
1221612295
"description": "Will be set to true if the activity is paused."
12296+
},
12297+
"activityReset": {
12298+
"type": "boolean",
12299+
"description": "Will be set to true if the activity was reset.\nApplies only to the current run."
1221712300
}
1221812301
}
1221912302
},
@@ -12227,6 +12310,10 @@
1222712310
"activityPaused": {
1222812311
"type": "boolean",
1222912312
"description": "Will be set to true if the activity is paused."
12313+
},
12314+
"activityReset": {
12315+
"type": "boolean",
12316+
"description": "Will be set to true if the activity was reset.\nApplies only to the current run."
1223012317
}
1223112318
}
1223212319
},
@@ -13802,6 +13889,10 @@
1380213889
"type": "boolean",
1380313890
"description": "If true, a new workflow was started."
1380413891
},
13892+
"status": {
13893+
"$ref": "#/definitions/v1WorkflowExecutionStatus",
13894+
"description": "Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING\nunless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs)."
13895+
},
1380513896
"eagerWorkflowTask": {
1380613897
"$ref": "#/definitions/v1PollWorkflowTaskQueueResponse",
1380713898
"description": "When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will\nreturn the first workflow task to be eagerly executed.\nThe caller is expected to have a worker available to process the task."

‎openapi/openapiv3.yaml‎

Lines changed: 110 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6309,6 +6309,14 @@ components:
63096309
type: string
63106310
description: History event reapply options (deprecated, use `options`).
63116311
format: enum
6312+
postResetOperations:
6313+
type: array
6314+
items:
6315+
$ref: '#/components/schemas/PostResetOperation'
6316+
description: |-
6317+
Operations to perform after the workflow has been reset. These operations will be applied
6318+
to the *new* run of the workflow execution in the order they are provided.
6319+
All operations are applied to the workflow before the first new workflow task is generated
63126320
description: |-
63136321
BatchOperationReset sends reset requests to batch workflows.
63146322
Keep the parameter in sync with temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.
@@ -6380,7 +6388,7 @@ components:
63806388
workflowExecutionOptions:
63816389
allOf:
63826390
- $ref: '#/components/schemas/WorkflowExecutionOptions'
6383-
description: Workflow Execution options. Partial updates are accepted and controlled by update_mask.
6391+
description: Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask.
63846392
updateMask:
63856393
type: string
63866394
description: |-
@@ -6508,6 +6516,13 @@ components:
65086516
$ref: '#/components/schemas/Callback_Nexus'
65096517
internal:
65106518
$ref: '#/components/schemas/Callback_Internal'
6519+
links:
6520+
type: array
6521+
items:
6522+
$ref: '#/components/schemas/Link'
6523+
description: |-
6524+
Links associated with the callback. It can be used to link to underlying resources of the
6525+
callback.
65116526
description: Callback to attach to various events in the system, e.g. workflow run completion.
65126527
CallbackInfo:
65136528
type: object
@@ -7380,6 +7395,13 @@ components:
73807395
type: array
73817396
items:
73827397
$ref: '#/components/schemas/ExecuteMultiOperationResponse_Response'
7398+
description: |-
7399+
IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination ("Update-with-Start") when both
7400+
1. the workflow update for the requested update ID has already completed, and
7401+
2. the workflow for the requested workflow ID has already been closed,
7402+
then you'll receive
7403+
- an update response containing the update's outcome, and
7404+
- a start response with a `status` field that reflects the workflow's current state.
73837405
ExecuteMultiOperationResponse_Response:
73847406
type: object
73857407
properties:
@@ -9101,6 +9123,52 @@ components:
91019123
description: |-
91029124
Attached to task responses to give hints to the SDK about how it may adjust its number of
91039125
pollers.
9126+
PostResetOperation:
9127+
type: object
9128+
properties:
9129+
signalWorkflow:
9130+
$ref: '#/components/schemas/PostResetOperation_SignalWorkflow'
9131+
updateWorkflowOptions:
9132+
$ref: '#/components/schemas/PostResetOperation_UpdateWorkflowOptions'
9133+
description: PostResetOperation represents an operation to be performed on the new workflow execution after a workflow reset.
9134+
PostResetOperation_SignalWorkflow:
9135+
type: object
9136+
properties:
9137+
signalName:
9138+
type: string
9139+
description: The workflow author-defined name of the signal to send to the workflow.
9140+
input:
9141+
allOf:
9142+
- $ref: '#/components/schemas/Payloads'
9143+
description: Serialized value(s) to provide with the signal.
9144+
header:
9145+
allOf:
9146+
- $ref: '#/components/schemas/Header'
9147+
description: Headers that are passed with the signal to the processing workflow.
9148+
links:
9149+
type: array
9150+
items:
9151+
$ref: '#/components/schemas/Link'
9152+
description: Links to be associated with the WorkflowExecutionSignaled event.
9153+
description: |-
9154+
SignalWorkflow represents sending a signal after a workflow reset.
9155+
Keep the parameter in sync with temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.
9156+
PostResetOperation_UpdateWorkflowOptions:
9157+
type: object
9158+
properties:
9159+
workflowExecutionOptions:
9160+
allOf:
9161+
- $ref: '#/components/schemas/WorkflowExecutionOptions'
9162+
description: Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask.
9163+
updateMask:
9164+
type: string
9165+
description: |-
9166+
Controls which fields from `workflow_execution_options` will be applied.
9167+
To unset a field, set it to null and use the update mask to indicate that it should be mutated.
9168+
format: field-mask
9169+
description: |-
9170+
UpdateWorkflowOptions represents updating workflow execution options after a workflow reset.
9171+
Keep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.
91049172
Priority:
91059173
type: object
91069174
properties:
@@ -9240,6 +9308,11 @@ components:
92409308
activityPaused:
92419309
type: boolean
92429310
description: Will be set to true if the activity is paused.
9311+
activityReset:
9312+
type: boolean
9313+
description: |-
9314+
Will be set to true if the activity was reset.
9315+
Applies only to the current run.
92439316
RecordActivityTaskHeartbeatRequest:
92449317
type: object
92459318
properties:
@@ -9267,6 +9340,11 @@ components:
92679340
activityPaused:
92689341
type: boolean
92699342
description: Will be set to true if the activity is paused.
9343+
activityReset:
9344+
type: boolean
9345+
description: |-
9346+
Will be set to true if the activity was reset.
9347+
Applies only to the current run.
92709348
RegisterNamespaceRequest:
92719349
type: object
92729350
properties:
@@ -9668,6 +9746,14 @@ components:
96689746
type: string
96699747
format: enum
96709748
description: Event types not to be reapplied
9749+
postResetOperations:
9750+
type: array
9751+
items:
9752+
$ref: '#/components/schemas/PostResetOperation'
9753+
description: |-
9754+
Operations to perform after the workflow has been reset. These operations will be applied
9755+
to the *new* run of the workflow execution in the order they are provided.
9756+
All operations are applied to the workflow before the first new workflow task is generated
96719757
ResetWorkflowExecutionResponse:
96729758
type: object
96739759
properties:
@@ -10708,6 +10794,10 @@ components:
1070810794
items:
1070910795
$ref: '#/components/schemas/Link'
1071010796
description: Links to be associated with the WorkflowExecutionSignaled event.
10797+
description: |-
10798+
Keep the parameters in sync with:
10799+
- temporal.api.batch.v1.BatchOperationSignal.
10800+
- temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
1071110801
SignalWorkflowExecutionResponse:
1071210802
type: object
1071310803
properties: {}
@@ -11011,6 +11101,21 @@ components:
1101111101
started:
1101211102
type: boolean
1101311103
description: If true, a new workflow was started.
11104+
status:
11105+
enum:
11106+
- WORKFLOW_EXECUTION_STATUS_UNSPECIFIED
11107+
- WORKFLOW_EXECUTION_STATUS_RUNNING
11108+
- WORKFLOW_EXECUTION_STATUS_COMPLETED
11109+
- WORKFLOW_EXECUTION_STATUS_FAILED
11110+
- WORKFLOW_EXECUTION_STATUS_CANCELED
11111+
- WORKFLOW_EXECUTION_STATUS_TERMINATED
11112+
- WORKFLOW_EXECUTION_STATUS_CONTINUED_AS_NEW
11113+
- WORKFLOW_EXECUTION_STATUS_TIMED_OUT
11114+
type: string
11115+
description: |-
11116+
Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING
11117+
unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).
11118+
format: enum
1101411119
eagerWorkflowTask:
1101511120
allOf:
1101611121
- $ref: '#/components/schemas/PollWorkflowTaskQueueResponse'
@@ -11707,6 +11812,10 @@ components:
1170711812
Controls which fields from `workflow_execution_options` will be applied.
1170811813
To unset a field, set it to null and use the update mask to indicate that it should be mutated.
1170911814
format: field-mask
11815+
description: |-
11816+
Keep the parameters in sync with:
11817+
- temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions.
11818+
- temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions.
1171011819
UpdateWorkflowExecutionOptionsResponse:
1171111820
type: object
1171211821
properties:

0 commit comments

Comments
 (0)