Deprecate history field

temporalio · Nov 15, 2024 · d6d0a99 · d6d0a99
1 parent cad0299
commit d6d0a99
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json
@@ -12158,6 +12158,10 @@
           "$ref": "#/definitions/v1Header",
           "description": "Headers that were passed by the sender of the signal and copied by temporal \nserver into the workflow task."
         },
+        "skipGenerateWorkflowTask": {
+          "type": "boolean",
+          "description": "This field is deprecated and never respected. It should always be set to false."
+        },
         "externalWorkflowExecution": {
           "$ref": "#/definitions/v1WorkflowExecution",
           "description": "When signal origin is a workflow execution, this field is set."

diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml
@@ -9682,6 +9682,9 @@ components:
           allOf:
             - $ref: '#/components/schemas/Header'
           description: "Headers that were passed by the sender of the signal and copied by temporal \n server into the workflow task."
+        skipGenerateWorkflowTask:
+          type: boolean
+          description: This field is deprecated and never respected. It should always be set to false.
         externalWorkflowExecution:
           allOf:
             - $ref: '#/components/schemas/WorkflowExecution'

diff --git a/temporal/api/history/v1/message.proto b/temporal/api/history/v1/message.proto
@@ -472,7 +472,8 @@ message WorkflowExecutionSignaledEventAttributes {
     // Headers that were passed by the sender of the signal and copied by temporal 
     // server into the workflow task.
     temporal.api.common.v1.Header header = 4;
-    reserved 5;
+    // This field is deprecated and never respected. It should always be set to false.
+    bool skip_generate_workflow_task = 5 [deprecated = true];
     // When signal origin is a workflow execution, this field is set.
     temporal.api.common.v1.WorkflowExecution external_workflow_execution = 6;
 }