Skip to content

Commit 525ec42

Browse files
committed
refine comments of TimeSkippingConfig
1 parent 78e6bfb commit 525ec42

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

openapi/openapiv2.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16295,11 +16295,11 @@
1629516295
"properties": {
1629616296
"enabled": {
1629716297
"type": "boolean",
16298-
"description": "Enables or disables automatic time skipping for this workflow execution.\nBy default, this field is propagated to child workflows at the time they are started.\nChanges made after a child workflow has started are not propagated."
16298+
"description": "Enables or disables automatic time skipping for this workflow execution.\nBy default, this field is propagated to transitively related workflows (child workflows/start-as-new/reset) \nat the time they are started.\nChanges made after a transitively related workflow has started are not propagated."
1629916299
},
1630016300
"disablePropagation": {
1630116301
"type": "boolean",
16302-
"description": "If set, the enabled field is not propagated to child workflows."
16302+
"description": "If set, the enabled field is not propagated to transitively related workflows."
1630316303
},
1630416304
"maxSkippedDuration": {
1630516305
"type": "string",

openapi/openapiv3.yaml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14455,13 +14455,10 @@ components:
1445514455
properties:
1445614456
enabled:
1445714457
type: boolean
14458-
description: |-
14459-
Enables or disables automatic time skipping for this workflow execution.
14460-
By default, this field is propagated to child workflows at the time they are started.
14461-
Changes made after a child workflow has started are not propagated.
14458+
description: "Enables or disables automatic time skipping for this workflow execution.\n By default, this field is propagated to transitively related workflows (child workflows/start-as-new/reset) \n at the time they are started.\n Changes made after a transitively related workflow has started are not propagated."
1446214459
disablePropagation:
1446314460
type: boolean
14464-
description: If set, the enabled field is not propagated to child workflows.
14461+
description: If set, the enabled field is not propagated to transitively related workflows.
1446514462
maxSkippedDuration:
1446614463
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
1446714464
type: string

temporal/api/workflow/v1/message.proto

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -579,11 +579,12 @@ message WorkflowExecutionOptions {
579579
message TimeSkippingConfig {
580580

581581
// Enables or disables automatic time skipping for this workflow execution.
582-
// By default, this field is propagated to child workflows at the time they are started.
583-
// Changes made after a child workflow has started are not propagated.
582+
// By default, this field is propagated to transitively related workflows (child workflows/start-as-new/reset)
583+
// at the time they are started.
584+
// Changes made after a transitively related workflow has started are not propagated.
584585
bool enabled = 1;
585586

586-
// If set, the enabled field is not propagated to child workflows.
587+
// If set, the enabled field is not propagated to transitively related workflows.
587588
bool disable_propagation = 2;
588589

589590
// Optional bound that limits how long time skipping remains active.
@@ -594,9 +595,10 @@ message TimeSkippingConfig {
594595
// are expected to receive signals, updates, or other events while
595596
// timers are in progress.
596597
//
597-
// This bound is not propagated to child workflows.
598-
// It is recommended to set disable_propagation to true
599-
// and configure TimeSkippingConfig explicitly in child workflows.
598+
// This bound is not propagated to transitively related workflows.
599+
// When bound is also needed for transitively related workflows,
600+
// it is recommended to set disable_propagation to true
601+
// and configure TimeSkippingConfig explicitly for transitively related workflows.
600602
oneof bound {
601603

602604
// Maximum total virtual time that can be skipped.

0 commit comments

Comments
 (0)