VersionStatus for WorkerDeploymentVersions

openapi/openapiv2.json

@@ -7107,6 +7107,10 @@
           "type": "string",
           "description": "Deprecated. Use `deployment_version`."
         },
+        "status": {
+          "$ref": "#/definitions/v1WorkerDeploymentVersionStatus",
+          "description": "The status of the Worker Deployment Version."
+        },
         "deploymentVersion": {
           "$ref": "#/definitions/v1WorkerDeploymentVersion",
           "description": "Required."
@@ -14957,6 +14961,10 @@
           "type": "string",
           "description": "Deprecated. Use `deployment_version`."
         },
+        "status": {
+          "$ref": "#/definitions/v1WorkerDeploymentVersionStatus",
+          "description": "The status of the Worker Deployment Version."
+        },
         "deploymentVersion": {
           "$ref": "#/definitions/v1WorkerDeploymentVersion",
           "description": "Required."
@@ -15017,6 +15025,19 @@
       },
       "description": "A Worker Deployment Version (Version, for short) represents all workers of the same \ncode and config within a Deployment. Workers of the same Version are expected to \nbehave exactly the same so when executions move between them there are no \nnon-determinism issues.\nWorker Deployment Versions are created in Temporal server automatically when \ntheir first poller arrives to the server.\nExperimental. Worker Deployments are experimental and might significantly change in the future."
     },
+    "v1WorkerDeploymentVersionStatus": {
+      "type": "string",
+      "enum": [
+        "WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED",
+        "WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE",
+        "WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT",
+        "WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING",
+        "WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING",
+        "WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED"
+      ],
+      "default": "WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED",
+      "description": "Specify the status of a Worker Deployment Version.\nExperimental. Worker Deployments are experimental and might significantly change in the future.\n\n - WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE: The Worker Deployment Version has been created inside the Worker Deployment but is not used by any\nworkflow executions. These Versions can still have workflows if they have an explicit Versioning Override targeting\nthis Version. Such Versioning Override could be set at workflow start time, or at a later time via `UpdateWorkflowExecutionOptions`.\n - WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT: The Worker Deployment Version is the current version of the Worker Deployment. All new workflow executions \nand tasks of existing unversioned or AutoUpgrade workflows are routed to this version.\n - WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING: The Worker Deployment Version is the ramping version of the Worker Deployment. A subset of new Pinned workflow executions are \nrouted to this version. Moreover, a portion of existing unversioned or AutoUpgrade workflow executions are also routed to this version.\n - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING: The Worker Deployment Version is not used by new workflows but is still used by\nopen pinned workflows. The version cannot be decommissioned safely.\n - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED: The Worker Deployment Version is not used by new or open workflows, but might be still needed by\nQueries sent to closed workflows. The version can be decommissioned safely if user does\nnot query closed workflows. If the user does query closed workflows for some time x after\nworkflows are closed, they should decommission the version after it has been drained for that duration."
+    },
     "v1WorkerVersionCapabilities": {
       "type": "object",
       "properties": {

openapi/openapiv3.yaml

@@ -12223,6 +12223,17 @@ components:
         version:
           type: string
           description: Deprecated. Use `deployment_version`.
+        status:
+          enum:
+            - WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED
+            - WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE
+            - WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT
+            - WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING
+            - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING
+            - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED
+          type: string
+          description: The status of the Worker Deployment Version.
+          format: enum
         deploymentVersion:
           allOf:
             - $ref: '#/components/schemas/WorkerDeploymentVersion'
@@ -12320,6 +12331,17 @@ components:
         version:
           type: string
           description: Deprecated. Use `deployment_version`.
+        status:
+          enum:
+            - WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED
+            - WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE
+            - WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT
+            - WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING
+            - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING
+            - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED
+          type: string
+          description: The status of the Worker Deployment Version.
+          format: enum
         deploymentVersion:
           allOf:
             - $ref: '#/components/schemas/WorkerDeploymentVersion'

temporal/api/deployment/v1/message.proto

@@ -97,6 +97,9 @@ message WorkerDeploymentVersionInfo {
     // Deprecated. Use `deployment_version`.
     string version = 1 [deprecated = true];
 
+    // The status of the Worker Deployment Version.
+    temporal.api.enums.v1.WorkerDeploymentVersionStatus status = 14;
+
     // Required.
     WorkerDeploymentVersion deployment_version = 11;
     string deployment_name = 2;
@@ -195,6 +198,9 @@ message WorkerDeploymentInfo {
         // Deprecated. Use `deployment_version`.
         string version = 1 [deprecated = true];
 
+        // The status of the Worker Deployment Version.
+        temporal.api.enums.v1.WorkerDeploymentVersionStatus status = 11;
+
         // Required.
         WorkerDeploymentVersion deployment_version = 4;
         google.protobuf.Timestamp create_time = 2;

temporal/api/enums/v1/deployment.proto

@@ -72,3 +72,29 @@ enum WorkerVersioningMode {
     // VersioningBehavior enum.)
     WORKER_VERSIONING_MODE_VERSIONED = 2;
 }
+
+// (-- api-linter: core::0216::synonyms=disabled
+//     aip.dev/not-precedent: Call this status because it is . --)
+// Specify the status of a Worker Deployment Version.
+// Experimental. Worker Deployments are experimental and might significantly change in the future.
+enum WorkerDeploymentVersionStatus {
+    WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED = 0;
+    // The Worker Deployment Version has been created inside the Worker Deployment but is not used by any
+    // workflow executions. These Versions can still have workflows if they have an explicit Versioning Override targeting
+    // this Version. Such Versioning Override could be set at workflow start time, or at a later time via `UpdateWorkflowExecutionOptions`.
+    WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE = 1;
+    // The Worker Deployment Version is the current version of the Worker Deployment. All new workflow executions 
+    // and tasks of existing unversioned or AutoUpgrade workflows are routed to this version.
+    WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT = 2;
+    // The Worker Deployment Version is the ramping version of the Worker Deployment. A subset of new Pinned workflow executions are 
+    // routed to this version. Moreover, a portion of existing unversioned or AutoUpgrade workflow executions are also routed to this version.
+    WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING = 3;
+    // The Worker Deployment Version is not used by new workflows but is still used by
+    // open pinned workflows. The version cannot be decommissioned safely.
+    WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING = 4;
+    // The Worker Deployment Version is not used by new or open workflows, but might be still needed by
+    // Queries sent to closed workflows. The version can be decommissioned safely if user does
+    // not query closed workflows. If the user does query closed workflows for some time x after
+    // workflows are closed, they should decommission the version after it has been drained for that duration.
+    WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED = 5;
+}