save

Author: carlydf

temporal/api/deployment/v1/message.proto

@@ -241,31 +241,28 @@ message VersionMetadata {
 }
 
 message RoutingConfig {
-    // Always present. Specifies which Deployment Version should should receive new workflow
-    // executions and tasks of existing unversioned or AutoUpgrade workflows.
+    // Specifies which Deployment Version should should receive new workflow executions and tasks of
+    // existing unversioned or AutoUpgrade workflows.
+    // Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
     // Note: Current Version is overridden by the Ramping Version for a portion of traffic when a ramp
-    // is set (see `ramping_version`.)
-    oneof current {
-        temporal.api.deployment.v1.WorkerDeploymentVersion current_deployment_version = 7;
-        // Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
-        bool current_unversioned = 8;
-    }
-    // Deprecated. Use `current`.
+    // is set and ramp percentage is non-zero (see `ramping_deployment_version`.)
+    temporal.api.deployment.v1.WorkerDeploymentVersion current_deployment_version = 7;
+    // Deprecated. Use `current_deployment_version`.
     string current_version = 1 [deprecated = true];
-    // When present, it means the traffic is being shifted from the Current Version to the Ramping Version.
+
+    // When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.
     // Must always be different from Current Version.
+    // Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
     // Note that it is possible to ramp from one Version to another Version, or from unversioned
     // workers to a particular Version, or from a particular Version to unversioned workers.
-    oneof ramping {
-        temporal.api.deployment.v1.WorkerDeploymentVersion ramping_deployment_version = 9;
-        // Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
-        bool ramping_unversioned = 10;
-    }
+    temporal.api.deployment.v1.WorkerDeploymentVersion ramping_deployment_version = 9;
     // Deprecated. Use `ramping`.
     string ramping_version = 2 [deprecated = true];
+
     // Percentage of tasks that are routed to the Ramping Version instead of the Current Version.
     // Valid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but
     // not yet "promoted" to be the Current Version, likely due to pending validations.
+    // A 0% value means the Ramping Version is receiving no traffic.
     float ramping_version_percentage = 3;
     // Last time current version was changed.
     google.protobuf.Timestamp current_version_changed_time = 4;

temporal/api/taskqueue/v1/message.proto

@@ -57,31 +57,28 @@ message TaskQueueMetadata {
 
 // Experimental. Worker Deployments are experimental and might significantly change in the future.
 message TaskQueueVersioningInfo {
-    // Always present. Specifies which Deployment Version should receive new workflow
-    // executions and tasks of existing unversioned or AutoUpgrade workflows.
+    // Specifies which Deployment Version should receive new workflow executions and tasks of
+    // existing unversioned or AutoUpgrade workflows.
+    // Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
     // Note: Current Version is overridden by the Ramping Version for a portion of traffic when a ramp
     // is set (see `ramping_version`.)
-    oneof current {
-        temporal.api.deployment.v1.WorkerDeploymentVersion current_deployment_version = 7;
-        // Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
-        bool current_unversioned = 8;
-    }
-    // Deprecated. Use `current`.
+    temporal.api.deployment.v1.WorkerDeploymentVersion current_deployment_version = 7;
+    // Deprecated. Use `current_deployment_version`.
     string current_version = 1 [deprecated = true];
-    // When present, it means the traffic is being shifted from the Current Version to the Ramping Version.
-    // Must always be different from `current_version`.
+
+    // When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.
+    // Must always be different from `current_deployment_version`.
+    // Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
     // Note that it is possible to ramp from one Version to another Version, or from unversioned
     // workers to a particular Version, or from a particular Version to unversioned workers.
-    oneof ramping {
-        temporal.api.deployment.v1.WorkerDeploymentVersion ramping_deployment_version = 9;
-        // Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
-        bool ramping_unversioned = 10;
-    }
+    temporal.api.deployment.v1.WorkerDeploymentVersion ramping_deployment_version = 9;
     // Deprecated. Use `ramping`.
     string ramping_version = 2 [deprecated = true];
+
     // Percentage of tasks that are routed to the Ramping Version instead of the Current Version.
     // Valid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but
     // not yet "promoted" to be the Current Version, likely due to pending validations.
+    // A 0% value means the Ramping Version is receiving no traffic.
     float ramping_version_percentage = 3;
     // Last time versioning information of this Task Queue changed.
     google.protobuf.Timestamp update_time = 4;

temporal/api/workflowservice/v1/request_response.proto

@@ -2024,18 +2024,15 @@ message SetCurrentDeploymentResponse {
 // Set/unset the Current Version of a Worker Deployment.
 message SetWorkerDeploymentCurrentVersionRequest {
     string namespace = 1;
-    // Deprecated. Use `current`.
-    string deployment_name = 2 [deprecated = true];
-    // Deprecated. Use `current`.
+    string deployment_name = 2;
+    // Deprecated. Use `build_id`.
     string version = 3 [deprecated = true];
 
-    // Required.
-    oneof current {
-        temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 7;
-        // The name of the Deployment where you want to set Current Version to unversioned.
-        // Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
-        string unversioned_deployment_name = 8;
-    };
+    // The build id of the version that you want to set as Current.
+    // Pass an empty value to set the Current Version to nil.
+    // A nil Current Version represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
+    string build_id = 7;
+
     // Optional. This can be the value of conflict_token from a Describe, or another Worker
     // Deployment API. Passing a non-nil conflict token will cause this request to fail if the
     // Deployment's configuration has been modified between the API call that generated the
@@ -2064,29 +2061,24 @@ message SetWorkerDeploymentCurrentVersionResponse {
     // that write to the Worker Deployment state to ensure that the state
     // did not change between this API call and a future write.
     bytes conflict_token = 1;
-    // Deprecated. Use `replaced_version`.
+    // Deprecated. Use `previous_deployment_version`.
     string previous_version = 2 [deprecated = true];
     // The version that was current before executing this operation.
-    oneof replaced_version {
-        temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 3;
-        bool unversioned = 4;
-    };
+    temporal.api.deployment.v1.WorkerDeploymentVersion previous_deployment_version = 3;
 }
 
 // Set/unset the Ramping Version of a Worker Deployment and its ramp percentage.
 message SetWorkerDeploymentRampingVersionRequest {
     string namespace = 1;
-    // Deprecated. Use `ramping`.
-    string deployment_name = 2 [deprecated = true];
-    // Deprecated. Use `ramping`.
+    string deployment_name = 2;
+    // Deprecated. Use `build_id`.
     string version = 3 [deprecated = true];
-    // Pass an empty value to unset the Ramping Version. Must be paired with `percentage=0`.
-    oneof ramping {
-        temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 8;
-        // The name of the Deployment where you want to set Ramping Version to unversioned.
-        // Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
-        string unversioned_deployment_name = 9;
-    };
+
+    // The build id of the version that you want to ramp traffic to.
+    // Pass an empty value to set the Ramping Version to nil.
+    // A nil Ramping Version represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
+    string build_id = 8;
+
     // Ramp percentage to set. Valid range: [0,100].
     float percentage = 4;
 
@@ -2121,13 +2113,10 @@ message SetWorkerDeploymentRampingVersionResponse {
     // that write to the Worker Deployment state to ensure that the state
     // did not change between this API call and a future write.
     bytes conflict_token = 1;
-    // Deprecated. Use `replaced_version`.
+    // Deprecated. Use `previous_deployment_version`.
     string previous_version = 2 [deprecated = true];
     // The version that was ramping before executing this operation.
-    oneof replaced_version {
-        temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 4;
-        bool unversioned = 5;
-    };
+    temporal.api.deployment.v1.WorkerDeploymentVersion previous_deployment_version = 4;
     // The ramping version percentage before executing this operation.
     float previous_percentage = 3;
 }

temporal/api/workflowservice/v1/service.proto

@@ -858,10 +858,10 @@ service WorkflowService {
     // Experimental. This API might significantly change or be removed in a future release.
     rpc SetWorkerDeploymentCurrentVersion (SetWorkerDeploymentCurrentVersionRequest) returns (SetWorkerDeploymentCurrentVersionResponse) {
         option (google.api.http) = {
-            post: "/namespaces/{namespace}/worker-deployments/set-current-version"
+            post: "/namespaces/{namespace}/worker-deployments/{deployment_name}/set-current-version"
             body: "*"
             additional_bindings {
-                post: "/api/v1/namespaces/{namespace}/worker-deployments/set-current-version"
+                post: "/api/v1/namespaces/{namespace}/worker-deployments/{deployment_name}/set-current-version"
                 body: "*"
             }
         };
@@ -912,10 +912,10 @@ service WorkflowService {
     // Experimental. This API might significantly change or be removed in a future release.
     rpc SetWorkerDeploymentRampingVersion (SetWorkerDeploymentRampingVersionRequest) returns (SetWorkerDeploymentRampingVersionResponse) {
         option (google.api.http) = {
-            post: "/namespaces/{namespace}/worker-deployments/set-ramping-version"
+            post: "/namespaces/{namespace}/worker-deployments/{deployment_name}/set-ramping-version"
             body: "*"
             additional_bindings {
-                post: "/api/v1/namespaces/{namespace}/worker-deployments/set-ramping-version"
+                post: "/api/v1/namespaces/{namespace}/worker-deployments/{deployment_name}/set-ramping-version"
                 body: "*"
             }
         };