refined the comment for WorkflowExecutionOptions

Author: feiyang3cat

openapi/openapiv2.json

@@ -21005,7 +21005,7 @@
         },
         "timeSkippingConfig": {
           "$ref": "#/definitions/v1TimeSkippingConfig",
-          "description": "Time-skipping configuration for this workflow execution.\nIf not set, the time-skipping configuration is not updated by this request;\nthe existing configuration is preserved.\n\nWhen `fast_forward` is set, time will be fast-forwarded to a future point relative\nto the current workflow timestamp. Each call takes effect, even if\n`fast_forward` is set to the same duration, since the target time is recalculated\nfrom the current timestamp on every call."
+          "description": "The time-skipping configuration for this workflow execution.\nWhen `fast_forward` is set, time will be fast-forwarded to a future point relative\nto the current workflow timestamp. Each call takes effect, even if\n`fast_forward` is set to the same duration, since the target time is recalculated\nfrom the current timestamp on every call.\n\nThis field must be updated as a whole; updating individual sub-fields is not supported.\nWhen setting the update mask in `UpdateWorkflowExecutionOptionsRequest`, \n`BatchOperationUpdateWorkflowExecutionOptions`, etc., use a mask that covers the entire field."
         }
       }
     },
@@ -21042,7 +21042,11 @@
         },
         "timeSkippingConfig": {
           "$ref": "#/definitions/v1TimeSkippingConfig",
-          "description": "If set, the time-skipping configuration was changed. Contains the full updated configuration."
+          "description": "TimeSkippingConfig override upserted in this event. Represents the full config."
+        },
+        "timeSkippingConfigUpdated": {
+          "type": "boolean",
+          "description": "Indicates the time skipping config was updated by the recent call to update\nworkflow execution options."
         },
         "workflowUpdateOptions": {
           "type": "array",

openapi/openapiv3.yaml

@@ -19531,15 +19531,7 @@ components:
         timeSkippingConfig:
           allOf:
             - $ref: '#/components/schemas/TimeSkippingConfig'
-          description: |-
-            Time-skipping configuration for this workflow execution.
-             If not set, the time-skipping configuration is not updated by this request;
-             the existing configuration is preserved.
-
-             When `fast_forward` is set, time will be fast-forwarded to a future point relative
-             to the current workflow timestamp. Each call takes effect, even if
-             `fast_forward` is set to the same duration, since the target time is recalculated
-             from the current timestamp on every call.
+          description: "The time-skipping configuration for this workflow execution.\n When `fast_forward` is set, time will be fast-forwarded to a future point relative\n to the current workflow timestamp. Each call takes effect, even if\n `fast_forward` is set to the same duration, since the target time is recalculated\n from the current timestamp on every call.\n\n This field must be updated as a whole; updating individual sub-fields is not supported.\n When setting the update mask in `UpdateWorkflowExecutionOptionsRequest`, \n `BatchOperationUpdateWorkflowExecutionOptions`, etc., use a mask that covers the entire field."
     WorkflowExecutionOptionsUpdatedEventAttributes:
       type: object
       properties:
@@ -19574,7 +19566,12 @@ components:
         timeSkippingConfig:
           allOf:
             - $ref: '#/components/schemas/TimeSkippingConfig'
-          description: If set, the time-skipping configuration was changed. Contains the full updated configuration.
+          description: TimeSkippingConfig override upserted in this event. Represents the full config.
+        timeSkippingConfigUpdated:
+          type: boolean
+          description: |-
+            Indicates the time skipping config was updated by the recent call to update
+             workflow execution options.
         workflowUpdateOptions:
           type: array
           items:

temporal/api/history/v1/message.proto

@@ -915,8 +915,14 @@ message WorkflowExecutionOptionsUpdatedEventAttributes {
     // Priority override upserted in this event. Represents the full priority; not just partial fields.
     // Ignored if nil.
     temporal.api.common.v1.Priority priority = 6;
-    // If set, the time-skipping configuration was changed. Contains the full updated configuration.
+
+    // TimeSkippingConfig override upserted in this event. Represents the full config.
     temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 7;
+
+    // Indicates the time skipping config was updated by the recent call to update
+    // workflow execution options.
+    bool time_skipping_config_updated = 9;
+
     // Updates to workflow updates options.
     repeated WorkflowUpdateOptionsUpdate workflow_update_options = 8;
 }

temporal/api/workflow/v1/message.proto

@@ -585,14 +585,15 @@ message WorkflowExecutionOptions {
     // If set, overrides the workflow's priority sent by the SDK.
     temporal.api.common.v1.Priority priority = 2;
 
-    // Time-skipping configuration for this workflow execution.
-    // If not set, the time-skipping configuration is not updated by this request;
-    // the existing configuration is preserved.
-    //
+    // The time-skipping configuration for this workflow execution.
     // When `fast_forward` is set, time will be fast-forwarded to a future point relative
     // to the current workflow timestamp. Each call takes effect, even if
     // `fast_forward` is set to the same duration, since the target time is recalculated
     // from the current timestamp on every call.
+    //
+    // This field must be updated as a whole; updating individual sub-fields is not supported.
+    // When setting the update mask in `UpdateWorkflowExecutionOptionsRequest`, 
+    // `BatchOperationUpdateWorkflowExecutionOptions`, etc., use a mask that covers the entire field.
     temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 3;
 }