addess comments

Author: rodrigozhou

openapi/openapiv2.json

@@ -6555,7 +6555,7 @@
         },
         "onConflictOptions": {
           "$ref": "#/definitions/v1OnConflictOptions",
-          "description": "It defines behaviors to be executed when the WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING\nconflict policy is used. If set to non-nil object, it will attach the RequestID to the\nexisting running workflow (for deduping), and perform actions specified in the object.\nIf not set (ie., nil value), it won't do anything to the existing running workflow."
+          "description": "It defines actions to be done to the existing running workflow when the conflict policy\nWORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a\nempty object (ie., all options with default value), it won't do anything to the existing\nrunning workflow. If set, it will add a history event to the running workflow."
         }
       }
     },
@@ -9982,14 +9982,20 @@
     "v1OnConflictOptions": {
       "type": "object",
       "properties": {
+        "attachRequestId": {
+          "type": "boolean",
+          "description": "Attaches the request ID to the running workflow."
+        },
         "attachCompletionCallbacks": {
-          "type": "boolean"
+          "type": "boolean",
+          "description": "Attaches the completion callbacks to the running workflow."
         },
         "attachLinks": {
-          "type": "boolean"
+          "type": "boolean",
+          "description": "Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event."
         }
       },
-      "description": "When StartWorkflowExecution uses the WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING conflict policy and\nthere is already an existing running workflow, OnConflictOptions defines actions to be taken on\nthe existing running workflow."
+      "description": "When StartWorkflowExecution uses the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING and\nthere is already an existing running workflow, OnConflictOptions defines actions to be taken on\nthe existing running workflow. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent\nhistory event in the running workflow with the changes requested in this object."
     },
     "v1Outcome": {
       "type": "object",
@@ -12027,7 +12033,7 @@
         },
         "onConflictOptions": {
           "$ref": "#/definitions/v1OnConflictOptions",
-          "description": "It defines behaviors to be executed when the WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING\nconflict policy is used. If set to non-nil object, it will attach the RequestID to the\nexisting running workflow (for deduping), and perform actions specified in the object.\nIf not set (ie., nil value), it won't do anything to the existing running workflow."
+          "description": "It defines actions to be done to the existing running workflow when the conflict policy\nWORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a\nempty object (ie., all options with default value), it won't do anything to the existing\nrunning workflow. If set, it will add a history event to the running workflow."
         }
       }
     },

openapi/openapiv3.yaml

@@ -7446,14 +7446,20 @@ components:
     OnConflictOptions:
       type: object
       properties:
+        attachRequestId:
+          type: boolean
+          description: Attaches the request ID to the running workflow.
         attachCompletionCallbacks:
           type: boolean
+          description: Attaches the completion callbacks to the running workflow.
         attachLinks:
           type: boolean
+          description: Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.
       description: |-
-        When StartWorkflowExecution uses the WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING conflict policy and
+        When StartWorkflowExecution uses the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING and
          there is already an existing running workflow, OnConflictOptions defines actions to be taken on
-         the existing running workflow.
+         the existing running workflow. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent
+         history event in the running workflow with the changes requested in this object.
     Outcome:
       type: object
       properties:
@@ -9397,10 +9403,10 @@ components:
           allOf:
             - $ref: '#/components/schemas/OnConflictOptions'
           description: |-
-            It defines behaviors to be executed when the WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING
-             conflict policy is used. If set to non-nil object, it will attach the RequestID to the
-             existing running workflow (for deduping), and perform actions specified in the object.
-             If not set (ie., nil value), it won't do anything to the existing running workflow.
+            It defines actions to be done to the existing running workflow when the conflict policy
+             WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a
+             empty object (ie., all options with default value), it won't do anything to the existing
+             running workflow. If set, it will add a history event to the running workflow.
     StartWorkflowExecutionResponse:
       type: object
       properties:

temporal/api/workflow/v1/message.proto

@@ -441,10 +441,15 @@ message VersioningOverride {
     temporal.api.deployment.v1.Deployment deployment = 2;
 }
 
-// When StartWorkflowExecution uses the WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING conflict policy and
+// When StartWorkflowExecution uses the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING and
 // there is already an existing running workflow, OnConflictOptions defines actions to be taken on
-// the existing running workflow.
+// the existing running workflow. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent
+// history event in the running workflow with the changes requested in this object.
 message OnConflictOptions {
-    bool attach_completion_callbacks = 1;
-    bool attach_links = 2;
+    // Attaches the request ID to the running workflow.
+    bool attach_request_id = 1;
+    // Attaches the completion callbacks to the running workflow.
+    bool attach_completion_callbacks = 2;
+    // Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.
+    bool attach_links = 3;
 }

temporal/api/workflowservice/v1/request_response.proto

@@ -206,10 +206,10 @@ message StartWorkflowExecutionRequest {
     // If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
     // To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
     temporal.api.workflow.v1.VersioningOverride versioning_override = 25;
-    // It defines behaviors to be executed when the WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING
-    // conflict policy is used. If set to non-nil object, it will attach the RequestID to the
-    // existing running workflow (for deduping), and perform actions specified in the object.
-    // If not set (ie., nil value), it won't do anything to the existing running workflow.
+    // It defines actions to be done to the existing running workflow when the conflict policy
+    // WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a
+    // empty object (ie., all options with default value), it won't do anything to the existing
+    // running workflow. If set, it will add a history event to the running workflow.
     temporal.api.workflow.v1.OnConflictOptions on_conflict_options = 26;
 }