Skip to content

Commit 8ecd433

Browse files
committed
comments:
1 parent c28f961 commit 8ecd433

4 files changed

Lines changed: 38 additions & 33 deletions

File tree

openapi/openapiv2.json

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7105,7 +7105,7 @@
71057105
"description": "Deprecated. Use `deployment_version`."
71067106
},
71077107
"status": {
7108-
"$ref": "#/definitions/v1VersionStatus",
7108+
"$ref": "#/definitions/v1WorkerDeploymentVersionStatus",
71097109
"description": "The status of the Worker Deployment Version."
71107110
},
71117111
"deploymentVersion": {
@@ -14844,18 +14844,6 @@
1484414844
}
1484514845
}
1484614846
},
14847-
"v1VersionStatus": {
14848-
"type": "string",
14849-
"enum": [
14850-
"VERSION_STATUS_UNSPECIFIED",
14851-
"VERSION_STATUS_CURRENT",
14852-
"VERSION_STATUS_RAMPING",
14853-
"VERSION_STATUS_DRAINING",
14854-
"VERSION_STATUS_DRAINED"
14855-
],
14856-
"default": "VERSION_STATUS_UNSPECIFIED",
14857-
"description": "Specify the status of a Worker Deployment Version.\nExperimental. Worker Deployments are experimental and might significantly change in the future.\n\n - VERSION_STATUS_UNSPECIFIED: The Worker Deployment Version has been created inside the Worker Deployment but is not used by any\nworkflow executions.\n - 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 - 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 - 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 - 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."
14858-
},
1485914847
"v1VersioningBehavior": {
1486014848
"type": "string",
1486114849
"enum": [
@@ -14971,7 +14959,7 @@
1497114959
"description": "Deprecated. Use `deployment_version`."
1497214960
},
1497314961
"status": {
14974-
"$ref": "#/definitions/v1VersionStatus",
14962+
"$ref": "#/definitions/v1WorkerDeploymentVersionStatus",
1497514963
"description": "The status of the Worker Deployment Version."
1497614964
},
1497714965
"deploymentVersion": {
@@ -15034,6 +15022,19 @@
1503415022
},
1503515023
"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."
1503615024
},
15025+
"v1WorkerDeploymentVersionStatus": {
15026+
"type": "string",
15027+
"enum": [
15028+
"WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED",
15029+
"WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE",
15030+
"WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT",
15031+
"WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING",
15032+
"WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING",
15033+
"WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED"
15034+
],
15035+
"default": "WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED",
15036+
"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."
15037+
},
1503715038
"v1WorkerVersionCapabilities": {
1503815039
"type": "object",
1503915040
"properties": {

openapi/openapiv3.yaml

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12219,11 +12219,12 @@ components:
1221912219
description: Deprecated. Use `deployment_version`.
1222012220
status:
1222112221
enum:
12222-
- VERSION_STATUS_UNSPECIFIED
12223-
- VERSION_STATUS_CURRENT
12224-
- VERSION_STATUS_RAMPING
12225-
- VERSION_STATUS_DRAINING
12226-
- VERSION_STATUS_DRAINED
12222+
- WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED
12223+
- WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE
12224+
- WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT
12225+
- WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING
12226+
- WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING
12227+
- WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED
1222712228
type: string
1222812229
description: The status of the Worker Deployment Version.
1222912230
format: enum
@@ -12326,11 +12327,12 @@ components:
1232612327
description: Deprecated. Use `deployment_version`.
1232712328
status:
1232812329
enum:
12329-
- VERSION_STATUS_UNSPECIFIED
12330-
- VERSION_STATUS_CURRENT
12331-
- VERSION_STATUS_RAMPING
12332-
- VERSION_STATUS_DRAINING
12333-
- VERSION_STATUS_DRAINED
12330+
- WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED
12331+
- WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE
12332+
- WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT
12333+
- WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING
12334+
- WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING
12335+
- WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED
1233412336
type: string
1233512337
description: The status of the Worker Deployment Version.
1233612338
format: enum

temporal/api/deployment/v1/message.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ message WorkerDeploymentVersionInfo {
9898
string version = 1 [deprecated = true];
9999

100100
// The status of the Worker Deployment Version.
101-
temporal.api.enums.v1.VersionStatus status = 14;
101+
temporal.api.enums.v1.WorkerDeploymentVersionStatus status = 14;
102102

103103
// Required.
104104
WorkerDeploymentVersion deployment_version = 11;
@@ -199,7 +199,7 @@ message WorkerDeploymentInfo {
199199
string version = 1 [deprecated = true];
200200

201201
// The status of the Worker Deployment Version.
202-
temporal.api.enums.v1.VersionStatus status = 11;
202+
temporal.api.enums.v1.WorkerDeploymentVersionStatus status = 11;
203203

204204
// Required.
205205
WorkerDeploymentVersion deployment_version = 4;

temporal/api/enums/v1/deployment.proto

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,22 +77,24 @@ enum WorkerVersioningMode {
7777
// aip.dev/not-precedent: Call this status because it is . --)
7878
// Specify the status of a Worker Deployment Version.
7979
// Experimental. Worker Deployments are experimental and might significantly change in the future.
80-
enum VersionStatus {
80+
enum WorkerDeploymentVersionStatus {
81+
WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED = 0;
8182
// The Worker Deployment Version has been created inside the Worker Deployment but is not used by any
82-
// workflow executions.
83-
VERSION_STATUS_UNSPECIFIED = 0;
83+
// workflow executions. These Versions can still have workflows if they have an explicit Versioning Override targeting
84+
// this Version. Such Versioning Override could be set at workflow start time, or at a later time via `UpdateWorkflowExecutionOptions`.
85+
WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE = 1;
8486
// The Worker Deployment Version is the current version of the Worker Deployment. All new workflow executions
8587
// and tasks of existing unversioned or AutoUpgrade workflows are routed to this version.
86-
VERSION_STATUS_CURRENT = 1;
88+
WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT = 2;
8789
// The Worker Deployment Version is the ramping version of the Worker Deployment. A subset of new Pinned workflow executions are
8890
// routed to this version. Moreover, a portion of existing unversioned or AutoUpgrade workflow executions are also routed to this version.
89-
VERSION_STATUS_RAMPING = 2;
91+
WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING = 3;
9092
// The Worker Deployment Version is not used by new workflows but is still used by
9193
// open pinned workflows. The version cannot be decommissioned safely.
92-
VERSION_STATUS_DRAINING = 3;
94+
WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING = 4;
9395
// The Worker Deployment Version is not used by new or open workflows, but might be still needed by
9496
// Queries sent to closed workflows. The version can be decommissioned safely if user does
9597
// not query closed workflows. If the user does query closed workflows for some time x after
9698
// workflows are closed, they should decommission the version after it has been drained for that duration.
97-
VERSION_STATUS_DRAINED = 4;
99+
WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED = 5;
98100
}

0 commit comments

Comments
 (0)