Merge branch 'master' of github.com:temporalio/api into cdf/pinned-can

Author: carlydf

README.md

@@ -6,6 +6,10 @@ This repository contains both the protobuf descriptors and OpenAPI documentation
 
 Install as git submodule to the project.
 
+## Contribution
+
+Make your change to the temporal/proto files, and run `make` to update the openapi definitions.
+
 ## License
 
 MIT License, please see [LICENSE](LICENSE) for details.

openapi/openapiv2.json

@@ -6399,7 +6399,7 @@ components:
             - RESET_TYPE_FIRST_WORKFLOW_TASK
             - RESET_TYPE_LAST_WORKFLOW_TASK
           type: string
-          description: Reset type (deprecated, use `options`).
+          description: Deprecated. Use `options`.
           format: enum
         resetReapplyType:
           enum:
@@ -6408,7 +6408,7 @@ components:
             - RESET_REAPPLY_TYPE_NONE
             - RESET_REAPPLY_TYPE_ALL_ELIGIBLE
           type: string
-          description: History event reapply options (deprecated, use `options`).
+          description: Deprecated. Use `options`.
           format: enum
         postResetOperations:
           type: array
@@ -7548,7 +7548,7 @@ components:
           $ref: '#/components/schemas/WorkflowExecution'
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
     FailoverStatus:
       type: object
       properties:
@@ -8674,7 +8674,7 @@ components:
           description: |-
             Operation ID - may be empty if the operation completed synchronously.
 
-             Deprecated: Renamed to operation_token.
+             Deprecated. Renamed to operation_token.
         operationToken:
           type: string
           description: Operation token - may be empty if the operation completed synchronously.
@@ -8917,16 +8917,16 @@ components:
         lastIndependentlyAssignedBuildId:
           type: string
           description: |-
-            This means the activity is independently versioned and not bound to the build ID of its workflow.
+            Deprecated. This means the activity is independently versioned and not bound to the build ID of its workflow.
              The activity will use the build id in this field instead.
              If the task fails and is scheduled again, the assigned build ID may change according to the latest versioning
              rules.
         lastWorkerVersionStamp:
           allOf:
             - $ref: '#/components/schemas/WorkerVersionStamp'
           description: |-
-            The version stamp of the worker to whom this activity was most recently dispatched
-             Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
+            Deprecated. The version stamp of the worker to whom this activity was most recently dispatched
+             This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
         currentRetryInterval:
           pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
           type: string
@@ -9030,7 +9030,7 @@ components:
           description: |-
             Operation ID. Only set for asynchronous operations after a successful StartOperation call.
 
-             Deprecated: Renamed to operation_token.
+             Deprecated. Renamed to operation_token.
         scheduleToCloseTimeout:
           pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
           type: string
@@ -9560,7 +9560,7 @@ components:
              corresponds to
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
     RequestCancelExternalWorkflowExecutionInitiatedEventAttributes:
       type: object
       properties:
@@ -9578,7 +9578,7 @@ components:
           $ref: '#/components/schemas/WorkflowExecution'
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
         childWorkflowOnly:
           type: boolean
           description: |-
@@ -9756,7 +9756,7 @@ components:
             - RESET_REAPPLY_TYPE_ALL_ELIGIBLE
           type: string
           description: |-
-            Event types to be reapplied (deprecated)
+            Deprecated. Use `options`.
              Default: RESET_REAPPLY_TYPE_SIGNAL
           format: enum
         currentRunOnly:
@@ -9787,7 +9787,7 @@ components:
           description: Worker build id.
         binaryChecksum:
           type: string
-          description: A worker binary version identifier (deprecated).
+          description: Deprecated. A worker binary version identifier.
         runId:
           type: string
           description: The first run ID in the execution chain that was touched by this worker build.
@@ -9848,7 +9848,7 @@ components:
             - RESET_REAPPLY_TYPE_ALL_ELIGIBLE
           type: string
           description: |-
-            Event types to be reapplied (deprecated)
+            Deprecated. Use `options`.
              Default: RESET_REAPPLY_TYPE_SIGNAL
           format: enum
         resetReapplyExcludeTypes:
@@ -10278,6 +10278,7 @@ components:
           format: date-time
         invalidScheduleError:
           type: string
+          description: Deprecated.
     ScheduleListEntry:
       type: object
       properties:
@@ -10432,7 +10433,9 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/CalendarSpec'
-          description: Any timestamps matching any of exclude_* will be skipped.
+          description: |-
+            Any timestamps matching any of exclude_* will be skipped.
+             Deprecated. Use exclude_structured_calendar.
         excludeStructuredCalendar:
           type: array
           items:
@@ -10727,7 +10730,7 @@ components:
           type: string
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
     SignalExternalWorkflowExecutionInitiatedEventAttributes:
       type: object
       properties:
@@ -10752,7 +10755,7 @@ components:
           description: Serialized arguments to provide to the signal handler
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
         childWorkflowOnly:
           type: boolean
           description: |-
@@ -10832,7 +10835,7 @@ components:
           description: Serialized value(s) to provide with the signal
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
         retryPolicy:
           allOf:
             - $ref: '#/components/schemas/RetryPolicy'
@@ -10908,7 +10911,7 @@ components:
           description: Used to de-dupe sent signals
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
         header:
           allOf:
             - $ref: '#/components/schemas/Header'
@@ -11001,7 +11004,7 @@ components:
           format: enum
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
         initiatedEventId:
           type: string
           description: Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
@@ -11049,7 +11052,7 @@ components:
           format: enum
         control:
           type: string
-          description: Deprecated
+          description: Deprecated.
         workflowTaskCompletedEventId:
           type: string
           description: The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
@@ -12912,10 +12915,12 @@ components:
         header:
           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."
+          description: |-
+            Headers that were passed by the sender of the signal and copied by temporal
+             server into the workflow task.
         skipGenerateWorkflowTask:
           type: boolean
-          description: This field is deprecated and never respected. It should always be set to false.
+          description: Deprecated. This field is never respected and should always be set to false.
         externalWorkflowExecution:
           allOf:
             - $ref: '#/components/schemas/WorkflowExecution'
@@ -13652,6 +13657,7 @@ components:
             - WORKFLOW_TASK_FAILED_CAUSE_PENDING_NEXUS_OPERATIONS_LIMIT_EXCEEDED
             - WORKFLOW_TASK_FAILED_CAUSE_BAD_REQUEST_CANCEL_NEXUS_OPERATION_ATTRIBUTES
             - WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED
+            - WORKFLOW_TASK_FAILED_CAUSE_GRPC_MESSAGE_TOO_LARGE
           type: string
           format: enum
         failure:
@@ -13673,7 +13679,7 @@ components:
         binaryChecksum:
           type: string
           description: |-
-            DEPRECATED since 1.21 - This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
+            Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
              If a worker explicitly failed this task, its binary id
         workerVersion:
           allOf:

openapi/openapiv3.yaml

@@ -77,10 +77,10 @@ message BatchOperationReset {
   // Describes what to reset to and how. If set, `reset_type` and `reset_reapply_type` are ignored.
   temporal.api.common.v1.ResetOptions options = 4;
 
-  // Reset type (deprecated, use `options`).
-  temporal.api.enums.v1.ResetType reset_type = 1;
-  // History event reapply options (deprecated, use `options`).
-  temporal.api.enums.v1.ResetReapplyType reset_reapply_type = 2;
+  // Deprecated. Use `options`.
+  temporal.api.enums.v1.ResetType reset_type = 1 [deprecated = true];
+  // Deprecated. Use `options`.
+  temporal.api.enums.v1.ResetReapplyType reset_reapply_type = 2 [deprecated = true];
   // Operations to perform after the workflow has been reset. These operations will be applied
   // to the *new* run of the workflow execution in the order they are provided.
   // All operations are applied to the workflow before the first new workflow task is generated

temporal/api/batch/v1/message.proto

@@ -106,7 +106,7 @@ message RequestCancelExternalWorkflowExecutionCommandAttributes {
     string workflow_id = 2;
     string run_id = 3;
     // Deprecated.
-    string control = 4;
+    string control = 4 [deprecated = true];
     // Set this to true if the workflow being cancelled is a child of the workflow originating this
     // command. The request will be rejected if it is set to true and the target workflow is *not*
     // a child of the requesting workflow.
@@ -123,7 +123,7 @@ message SignalExternalWorkflowExecutionCommandAttributes {
     // Serialized value(s) to provide with the signal.
     temporal.api.common.v1.Payloads input = 4;
     // Deprecated
-    string control = 5;
+    string control = 5 [deprecated = true];
     // Set this to true if the workflow being cancelled is a child of the workflow originating this
     // command. The request will be rejected if it is set to true and the target workflow is *not*
     // a child of the requesting workflow.

temporal/api/command/v1/message.proto

@@ -154,9 +154,9 @@ message ResetOptions {
         string build_id = 4;
     }
 
-    // Event types to be reapplied (deprecated)
+    // Deprecated. Use `options`.
     // Default: RESET_REAPPLY_TYPE_SIGNAL
-    temporal.api.enums.v1.ResetReapplyType reset_reapply_type = 10;
+    temporal.api.enums.v1.ResetReapplyType reset_reapply_type = 10 [deprecated = true];
 
     // If true, limit the reset to only within the current run. (Applies to build_id targets and
     // possibly others in the future.)

temporal/api/common/v1/message.proto

@@ -79,6 +79,8 @@ enum WorkflowTaskFailedCause {
     // for the workflow's namespace).
     // Check the workflow task failure message for more information.
     WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED = 35;
+    // A workflow task failed because a grpc message was too large.
+    WORKFLOW_TASK_FAILED_CAUSE_GRPC_MESSAGE_TOO_LARGE = 36;
 }
 
 enum StartChildWorkflowExecutionFailedCause {

temporal/api/enums/v1/failed_cause.proto

@@ -22,9 +22,9 @@ enum ResetReapplyExcludeType {
     RESET_REAPPLY_EXCLUDE_TYPE_CANCEL_REQUEST = 4 [deprecated=true];
 }
 
-// Event types to include when reapplying events. Deprecated: applications
-// should use ResetReapplyExcludeType to specify exclusions from this set, and
-// new event types should be added to ResetReapplyExcludeType instead of here.
+// Deprecated: applications should use ResetReapplyExcludeType to specify
+// exclusions from this set, and new event types should be added to ResetReapplyExcludeType
+// instead of here.
 enum ResetReapplyType {
     RESET_REAPPLY_TYPE_UNSPECIFIED = 0;
     // Signals are reapplied when workflow is reset.
@@ -35,7 +35,7 @@ enum ResetReapplyType {
     RESET_REAPPLY_TYPE_ALL_ELIGIBLE = 3;
 }
 
-// Reset type options. Deprecated, see temporal.api.common.v1.ResetOptions.
+// Deprecated, see temporal.api.common.v1.ResetOptions.
 enum ResetType {
     RESET_TYPE_UNSPECIFIED = 0;
     // Resets to event of the first workflow task completed, or if it does not exist, the event after task scheduled.

temporal/api/enums/v1/reset.proto

@@ -77,8 +77,8 @@ message NexusOperationFailureInfo {
     string operation = 4;
     // Operation ID - may be empty if the operation completed synchronously.
     //
-    // Deprecated: Renamed to operation_token.
-    string operation_id = 5;
+    // Deprecated. Renamed to operation_token.
+    string operation_id = 5 [deprecated = true];
     // Operation token - may be empty if the operation completed synchronously.
     string operation_token = 6;
 }