Merge branch 'master' into trampolining-rev-number

Author: Shivs11

openapi/openapiv2.json

@@ -1812,6 +1812,7 @@ paths:
               - TASK_QUEUE_KIND_UNSPECIFIED
               - TASK_QUEUE_KIND_NORMAL
               - TASK_QUEUE_KIND_STICKY
+              - TASK_QUEUE_KIND_WORKER_COMMANDS
             type: string
             format: enum
         - name: taskQueue.normalName
@@ -6046,6 +6047,7 @@ paths:
               - TASK_QUEUE_KIND_UNSPECIFIED
               - TASK_QUEUE_KIND_NORMAL
               - TASK_QUEUE_KIND_STICKY
+              - TASK_QUEUE_KIND_WORKER_COMMANDS
             type: string
             format: enum
         - name: taskQueue.normalName
@@ -8236,6 +8238,11 @@ components:
         canceledReason:
           type: string
           description: Set if activity cancelation was requested.
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+          description: Links to related entities, such as the entity that started this activity.
       description: Information about a standalone activity.
     ActivityExecutionListInfo:
       type: object
@@ -9066,10 +9073,6 @@ components:
           allOf:
             - $ref: '#/components/schemas/Callback'
           description: Information on how this callback should be invoked (e.g. its URL and type).
-        trigger:
-          allOf:
-            - $ref: '#/components/schemas/CallbackInfo_Trigger'
-          description: Trigger for this callback.
         registrationTime:
           type: string
           description: The time when the callback was registered.
@@ -9084,6 +9087,7 @@ components:
             - CALLBACK_STATE_SUCCEEDED
             - CALLBACK_STATE_BLOCKED
           type: string
+          description: The current state of the callback.
           format: enum
         attempt:
           type: integer
@@ -9106,16 +9110,7 @@ components:
         blockedReason:
           type: string
           description: If the state is BLOCKED, blocked reason provides additional information.
-      description: CallbackInfo contains the state of an attached workflow callback.
-    CallbackInfo_Trigger:
-      type: object
-      properties:
-        workflowClosed:
-          $ref: '#/components/schemas/CallbackInfo_WorkflowClosed'
-    CallbackInfo_WorkflowClosed:
-      type: object
-      properties: {}
-      description: Trigger for when the workflow is closed.
+      description: Common callback information. Specific CallbackInfo messages should embed this and may include additional fields.
     Callback_Internal:
       type: object
       properties:
@@ -9919,6 +9914,11 @@ components:
           type: string
           description: Token for follow-on long-poll requests. Absent only if the activity is complete.
           format: bytes
+        callbacks:
+          type: array
+          items:
+            $ref: '#/components/schemas/CallbackInfo'
+          description: Callbacks attached to this activity execution and their current state.
     DescribeBatchOperationResponse:
       type: object
       properties:
@@ -10737,7 +10737,7 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Link'
-          description: Links associated with the event.
+          description: Links to related entities, such as the entity that started this event's workflow.
         principal:
           allOf:
             - $ref: '#/components/schemas/Principal'
@@ -10875,9 +10875,28 @@ components:
         sourceDeploymentRevisionNumber:
           type: string
           description: The revision number of the source deployment version of the parent/previous workflow.
+        continueAsNewInitialVersioningBehavior:
+          enum:
+            - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_UNSPECIFIED
+            - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_AUTO_UPGRADE
+            - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_USE_RAMPING_VERSION
+          type: string
+          description: |-
+            Experimental.
+             If this workflow is the result of a continue-as-new, this field is set to the initial_versioning_behavior
+             specified in that command.
+             Only used for the initial task of this run and the initial task of any retries of this run.
+             Not passed to children or to future continue-as-new.
+
+             Note: In the first release of Upgrade-on-CaN, when the only ContinueAsNewVersioningBehavior was AutoUpgrade,
+             a non-empty InheritedAutoUpgradeInfo meant that the workflow should start as AutoUpgrade. So for compatibility
+             with history events generated during that time, know that an UNSPECIFIED value here is equivalent to AutoUpgrade
+             value if the InheritedAutoUpgradeInfo is non-empty.
+          format: enum
       description: |-
         Used as part of WorkflowExecutionStartedEventAttributes to pass down the AutoUpgrade behavior and source deployment version
          to a workflow execution whose parent/previous workflow has an AutoUpgrade behavior.
+         Also used for Upgrade-on-CaN behaviors AutoUpgrade and UseRampingVersion.
     Input:
       type: object
       properties:
@@ -10922,11 +10941,23 @@ components:
           $ref: '#/components/schemas/Link_WorkflowEvent'
         batchJob:
           $ref: '#/components/schemas/Link_BatchJob'
+        activity:
+          $ref: '#/components/schemas/Link_Activity'
       description: |-
         Link can be associated with history events. It might contain information about an external entity
          related to the history event. For example, workflow A makes a Nexus call that starts workflow B:
          in this case, a history event in workflow A could contain a Link to the workflow started event in
          workflow B, and vice-versa.
+    Link_Activity:
+      type: object
+      properties:
+        namespace:
+          type: string
+        activityId:
+          type: string
+        runId:
+          type: string
+      description: A link to an activity.
     Link_BatchJob:
       type: object
       properties:
@@ -11702,18 +11733,16 @@ components:
       properties:
         attachRequestId:
           type: boolean
-          description: Attaches the request ID to the running workflow.
+          description: Attaches the request ID to the running execution.
         attachCompletionCallbacks:
           type: boolean
-          description: Attaches the completion callbacks to the running workflow.
+          description: Attaches the completion callbacks to the running execution.
         attachLinks:
           type: boolean
-          description: Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.
+          description: Attaches the links to the running execution.
       description: |-
-        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. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent
-         history event in the running workflow with the changes requested in this object.
+        When starting an execution with a conflict policy that uses an existing execution and there is already an existing
+         running execution, OnConflictOptions defines actions to be taken on the existing running execution.
     Outcome:
       type: object
       properties:
@@ -14143,6 +14172,13 @@ components:
         started:
           type: boolean
           description: If true, a new workflow was started.
+        signalLink:
+          allOf:
+            - $ref: '#/components/schemas/Link'
+          description: |-
+            Link to be associated with the WorkflowExecutionSignaled event.
+             Added on the response to propagate the backlink.
+             Available from Temporal server 1.31 and up.
     SignalWorkflowExecutionRequest:
       type: object
       properties:
@@ -14183,7 +14219,14 @@ components:
            - temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
     SignalWorkflowExecutionResponse:
       type: object
-      properties: {}
+      properties:
+        link:
+          allOf:
+            - $ref: '#/components/schemas/Link'
+          description: |-
+            Link to be associated with the WorkflowExecutionSignaled event.
+             Added on the response to propagate the backlink.
+             Available from Temporal server 1.31 and up.
     StartActivityExecutionRequest:
       type: object
       properties:
@@ -14287,6 +14330,24 @@ components:
           allOf:
             - $ref: '#/components/schemas/Priority'
           description: Priority metadata.
+        completionCallbacks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Callback'
+          description: |-
+            Callbacks to be called by the server when this activity reaches a terminal state.
+             Callback addresses must be whitelisted in the server's dynamic configuration.
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+          description: |-
+            Links to be associated with the activity. Callbacks may also have associated links;
+             links already included with a callback should not be duplicated here.
+        onConflictOptions:
+          allOf:
+            - $ref: '#/components/schemas/OnConflictOptions'
+          description: Options for handling conflicts when using ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING.
     StartActivityExecutionResponse:
       type: object
       properties:
@@ -14296,6 +14357,10 @@ components:
         started:
           type: boolean
           description: If true, a new activity was started.
+        link:
+          allOf:
+            - $ref: '#/components/schemas/Link'
+          description: Link to the started activity.
     StartBatchOperationRequest:
       type: object
       properties:
@@ -14747,6 +14812,7 @@ components:
             - TASK_QUEUE_KIND_UNSPECIFIED
             - TASK_QUEUE_KIND_NORMAL
             - TASK_QUEUE_KIND_STICKY
+            - TASK_QUEUE_KIND_WORKER_COMMANDS
           type: string
           description: 'Default: TASK_QUEUE_KIND_NORMAL.'
           format: enum
@@ -16771,6 +16837,7 @@ components:
           enum:
             - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_UNSPECIFIED
             - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_AUTO_UPGRADE
+            - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_USE_RAMPING_VERSION
           type: string
           description: |-
             Experimental. Optionally decide the versioning behavior that the first task of the new run should use.
@@ -17074,6 +17141,11 @@ components:
           allOf:
             - $ref: '#/components/schemas/WorkflowExecution'
           description: When signal origin is a workflow execution, this field is set.
+        requestId:
+          type: string
+          description: |-
+            The request ID of the Signal request, used by the server to attach this to
+             the correct Event ID when generating link.
     WorkflowExecutionStartedEventAttributes:
       type: object
       properties:
@@ -17314,6 +17386,16 @@ components:
 
              Used internally by the server during continue-as-new and retry.
              Should not be read or interpreted by SDKs.
+        timeSkippingConfig:
+          allOf:
+            - $ref: '#/components/schemas/TimeSkippingConfig'
+          description: |-
+            Initial time-skipping configuration for this workflow execution, recorded at start time.
+             This may have been set explicitly via the start workflow request, or propagated from a
+             parent/previous execution.
+
+             The configuration may be updated after start via UpdateWorkflowExecutionOptions, which
+             will be reflected in the WorkflowExecutionOptionsUpdatedEvent.
       description: Always the first event in workflow history
     WorkflowExecutionTerminatedEventAttributes:
       type: object
@@ -17545,6 +17627,24 @@ components:
              Note: Pinned tasks and sticky tasks send a value of 0 for this field since these tasks do not
              face the problem of inconsistent dispatching that arises from eventual consistency between
              task queues and their partitions.
+        continueAsNewInitialVersioningBehavior:
+          enum:
+            - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_UNSPECIFIED
+            - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_AUTO_UPGRADE
+            - CONTINUE_AS_NEW_VERSIONING_BEHAVIOR_USE_RAMPING_VERSION
+          type: string
+          description: |-
+            Experimental.
+             If this workflow is the result of a continue-as-new, this field is set to the initial_versioning_behavior
+             specified in that command.
+             Only used for the initial task of this run and the initial task of any retries of this run.
+             Not passed to children or to future continue-as-new.
+
+             Note: In the first release of Upgrade-on-CaN, when the only ContinueAsNewVersioningBehavior was AutoUpgrade,
+             a non-empty InheritedAutoUpgradeInfo meant that the workflow should start as AutoUpgrade. So for compatibility
+             with ContinueAsNew history commands generated during that time, know that an UNSPECIFIED value here is equivalent
+             to ContinueAsNewVersioningBehaviorAutoUpgrade if the behavior of the workflow is AutoUpgrade.
+          format: enum
       description: |-
         Holds all the information about worker versioning for a particular workflow execution.
          Experimental. Versioning info is experimental and might change in the future.

openapi/openapiv3.yaml

@@ -15,6 +15,7 @@ import "google/protobuf/timestamp.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/deployment/v1/message.proto";
 import "temporal/api/enums/v1/activity.proto";
+import "temporal/api/callback/v1/message.proto";
 import "temporal/api/enums/v1/workflow.proto";
 import "temporal/api/failure/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
@@ -161,6 +162,9 @@ message ActivityExecutionInfo {
 
     // Set if activity cancelation was requested.
     string canceled_reason = 32;
+
+    // Links to related entities, such as the entity that started this activity.
+    repeated temporal.api.common.v1.Link links = 33;
 }
 
 // Limited activity information returned in the list response.
@@ -195,3 +199,20 @@ message ActivityExecutionListInfo {
     // This field is only populated if the activity is closed.
     google.protobuf.Duration execution_duration = 11;
 }
+
+// CallbackInfo contains the state of an attached activity callback.
+message CallbackInfo {
+    // Trigger for when the activity is closed.
+    message ActivityClosed {}
+
+    message Trigger {
+        oneof variant {
+            ActivityClosed activity_closed = 1;
+        }
+    }
+
+    // Trigger for this callback.
+    Trigger trigger = 1;
+    // Common callback info.
+    temporal.api.callback.v1.CallbackInfo info = 2;
+}

temporal/api/activity/v1/message.proto

@@ -0,0 +1,37 @@
+syntax = "proto3";
+
+package temporal.api.callback.v1;
+
+option go_package = "go.temporal.io/api/callback/v1;callback";
+option java_package = "io.temporal.api.callback.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Callback::V1";
+option csharp_namespace = "Temporalio.Api.Callback.V1";
+
+import "google/protobuf/timestamp.proto";
+
+import "temporal/api/common/v1/message.proto";
+import "temporal/api/enums/v1/common.proto";
+import "temporal/api/failure/v1/message.proto";
+
+// Common callback information. Specific CallbackInfo messages should embed this and may include additional fields.
+message CallbackInfo {
+    // Information on how this callback should be invoked (e.g. its URL and type).
+    temporal.api.common.v1.Callback callback = 1;
+    // The time when the callback was registered.
+    google.protobuf.Timestamp registration_time = 2;
+    // The current state of the callback.
+    temporal.api.enums.v1.CallbackState state = 3;
+    // The number of attempts made to deliver the callback.
+    // This number represents a minimum bound since the attempt is incremented after the callback request completes.
+    int32 attempt = 4;
+    // The time when the last attempt completed.
+    google.protobuf.Timestamp last_attempt_complete_time = 5;
+    // The last attempt's failure, if any.
+    temporal.api.failure.v1.Failure last_attempt_failure = 6;
+    // The time when the next attempt is scheduled.
+    google.protobuf.Timestamp next_attempt_schedule_time = 7;
+    // If the state is BLOCKED, blocked reason provides additional information.
+    string blocked_reason = 8;
+}