Merge branch 'master' of github.com:temporalio/api into versioning-override

Author: carlydf

openapi/openapiv2.json

@@ -9052,6 +9052,14 @@
         },
         "internal": {
           "$ref": "#/definitions/CallbackInternal"
+        },
+        "links": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/apicommonv1Link"
+          },
+          "description": "Links associated with the callback. It can be used to link to underlying resources of the\ncallback."
         }
       },
       "description": "Callback to attach to various events in the system, e.g. workflow run completion."
@@ -10189,7 +10197,8 @@
             "$ref": "#/definitions/v1ExecuteMultiOperationResponseResponse"
           }
         }
-      }
+      },
+      "description": "IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination (\"Update-with-Start\") when both\n  1. the workflow update for the requested update ID has already completed, and\n  2. the workflow for the requested workflow ID has already been closed,\nthen you'll receive\n  - an update response containing the update's outcome, and\n  - a start response with a `status` field that reflects the workflow's current state."
     },
     "v1ExecuteMultiOperationResponseResponse": {
       "type": "object",
@@ -12304,6 +12313,10 @@
         "activityPaused": {
           "type": "boolean",
           "description": "Will be set to true if the activity is paused."
+        },
+        "activityReset": {
+          "type": "boolean",
+          "description": "Will be set to true if the activity was reset.\nApplies only to the current run."
         }
       }
     },
@@ -12317,6 +12330,10 @@
         "activityPaused": {
           "type": "boolean",
           "description": "Will be set to true if the activity is paused."
+        },
+        "activityReset": {
+          "type": "boolean",
+          "description": "Will be set to true if the activity was reset.\nApplies only to the current run."
         }
       }
     },
@@ -13918,6 +13935,10 @@
           "type": "boolean",
           "description": "If true, a new workflow was started."
         },
+        "status": {
+          "$ref": "#/definitions/v1WorkflowExecutionStatus",
+          "description": "Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING\nunless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs)."
+        },
         "eagerWorkflowTask": {
           "$ref": "#/definitions/v1PollWorkflowTaskQueueResponse",
           "description": "When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will\nreturn the first workflow task to be eagerly executed.\nThe caller is expected to have a worker available to process the task."

openapi/openapiv3.yaml

@@ -6596,6 +6596,13 @@ components:
           $ref: '#/components/schemas/Callback_Nexus'
         internal:
           $ref: '#/components/schemas/Callback_Internal'
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+          description: |-
+            Links associated with the callback. It can be used to link to underlying resources of the
+             callback.
       description: Callback to attach to various events in the system, e.g. workflow run completion.
     CallbackInfo:
       type: object
@@ -7470,6 +7477,13 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/ExecuteMultiOperationResponse_Response'
+      description: |-
+        IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination ("Update-with-Start") when both
+           1. the workflow update for the requested update ID has already completed, and
+           2. the workflow for the requested workflow ID has already been closed,
+         then you'll receive
+           - an update response containing the update's outcome, and
+           - a start response with a `status` field that reflects the workflow's current state.
     ExecuteMultiOperationResponse_Response:
       type: object
       properties:
@@ -9336,6 +9350,11 @@ components:
         activityPaused:
           type: boolean
           description: Will be set to true if the activity is paused.
+        activityReset:
+          type: boolean
+          description: |-
+            Will be set to true if the activity was reset.
+             Applies only to the current run.
     RecordActivityTaskHeartbeatRequest:
       type: object
       properties:
@@ -9363,6 +9382,11 @@ components:
         activityPaused:
           type: boolean
           description: Will be set to true if the activity is paused.
+        activityReset:
+          type: boolean
+          description: |-
+            Will be set to true if the activity was reset.
+             Applies only to the current run.
     RegisterNamespaceRequest:
       type: object
       properties:
@@ -11112,6 +11136,21 @@ components:
         started:
           type: boolean
           description: If true, a new workflow was started.
+        status:
+          enum:
+            - WORKFLOW_EXECUTION_STATUS_UNSPECIFIED
+            - WORKFLOW_EXECUTION_STATUS_RUNNING
+            - WORKFLOW_EXECUTION_STATUS_COMPLETED
+            - WORKFLOW_EXECUTION_STATUS_FAILED
+            - WORKFLOW_EXECUTION_STATUS_CANCELED
+            - WORKFLOW_EXECUTION_STATUS_TERMINATED
+            - WORKFLOW_EXECUTION_STATUS_CONTINUED_AS_NEW
+            - WORKFLOW_EXECUTION_STATUS_TIMED_OUT
+          type: string
+          description: |-
+            Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING
+             unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).
+          format: enum
         eagerWorkflowTask:
           allOf:
             - $ref: '#/components/schemas/PollWorkflowTaskQueueResponse'

temporal/api/common/v1/message.proto

@@ -211,6 +211,10 @@ message Callback {
         Nexus nexus = 2;
         Internal internal = 3;
     }
+
+    // Links associated with the callback. It can be used to link to underlying resources of the
+    // callback.
+    repeated Link links = 100;
 }
 
 // Link can be associated with history events. It might contain information about an external entity

temporal/api/workflowservice/v1/request_response.proto

@@ -221,6 +221,9 @@ message StartWorkflowExecutionResponse {
     string run_id = 1;
     // If true, a new workflow was started.
     bool started = 3;
+    // Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING
+    // unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).
+    temporal.api.enums.v1.WorkflowExecutionStatus status = 5;
     // When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will
     // return the first workflow task to be eagerly executed.
     // The caller is expected to have a worker available to process the task.
@@ -526,6 +529,10 @@ message RecordActivityTaskHeartbeatResponse {
 
     // Will be set to true if the activity is paused.
     bool activity_paused = 2;
+
+    // Will be set to true if the activity was reset.
+    // Applies only to the current run.
+    bool activity_reset = 3;
 }
 
 message RecordActivityTaskHeartbeatByIdRequest {
@@ -550,6 +557,10 @@ message RecordActivityTaskHeartbeatByIdResponse {
 
     // Will be set to true if the activity is paused.
     bool activity_paused = 2;
+
+    // Will be set to true if the activity was reset.
+    // Applies only to the current run.
+    bool activity_reset = 3;
 }
 
 message RespondActivityTaskCompletedRequest {
@@ -1805,6 +1816,12 @@ message ExecuteMultiOperationRequest {
     }
 }
 
+// IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination ("Update-with-Start") when both
+//   1. the workflow update for the requested update ID has already completed, and
+//   2. the workflow for the requested workflow ID has already been closed,
+// then you'll receive
+//   - an update response containing the update's outcome, and
+//   - a start response with a `status` field that reflects the workflow's current state.
 message ExecuteMultiOperationResponse {
     repeated Response responses = 1;
 
@@ -1831,13 +1848,13 @@ message UpdateActivityOptionsRequest {
     // Controls which fields from `activity_options` will be applied
     google.protobuf.FieldMask update_mask = 5;
 
-    // either activity id or activity type must be provided
-    oneof activity {
-        // Only activity with this ID will be updated.
-        string id = 6;
-        // Update all running activities of this type.
-        string type = 7;
-    }
+        // either activity id or activity type must be provided
+        oneof activity {
+            // Only activity with this ID will be updated.
+            string id = 6;
+            // Update all running activities of this type.
+            string type = 7;
+        }
 }
 
 message UpdateActivityOptionsResponse {