Skip to content

Commit

Permalink
Remove WorkerVersionStamp.deployment_series_name (#485)
Browse files Browse the repository at this point in the history
* Add Deployment APIs

* Move UpdateDeploymentMemo to deployment dir

* Address feedback & rename deployment_name

* Addressed comments

* Addressed feedback

* WIP git rid of stamp

* Deprecate WorkerVersionStamp

* Rename RedirectInfo to DeploymentTransition

* undo enum comment change

* regen files

* Deprecate WorkerVersionStamp and replace it with Deployment

* Deprecate WorkerVersionStamp and replace it with Deployment

* Remove WorkerVersionStamp.deployment_series_name
  • Loading branch information
ShahabT authored Nov 20, 2024
1 parent ad41fcf commit 2bab1e0
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 24 deletions.
6 changes: 1 addition & 5 deletions openapi/openapiv2.json
Original file line number Diff line number Diff line change
Expand Up @@ -12379,13 +12379,9 @@
"useVersioning": {
"type": "boolean",
"description": "If set, the worker is opting in to worker versioning. Otherwise, this is used only as a\nmarker for workflow reset points and the BuildIDs search attribute."
},
"deploymentSeriesName": {
"type": "string",
"description": "Must be sent if user has set a deployment series name (versioning-3).\nDeprecated. SDK should return `Deployment` in the requests to server instead of populating\nthis field."
}
},
"description": "Identifies the version of a worker that received or processed a task\nDeprecated. This message is replaced with `Deployment` and `VersioningBehavior`."
"title": "Deprecated. This message is replaced with `Deployment` and `VersioningBehavior`.\nIdentifies the version of a worker that received or processed a task"
},
"v1WorkflowExecution": {
"type": "object",
Expand Down
10 changes: 2 additions & 8 deletions openapi/openapiv3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9770,15 +9770,9 @@ components:
description: |-
If set, the worker is opting in to worker versioning. Otherwise, this is used only as a
marker for workflow reset points and the BuildIDs search attribute.
deploymentSeriesName:
type: string
description: |-
Must be sent if user has set a deployment series name (versioning-3).
Deprecated. SDK should return `Deployment` in the requests to server instead of populating
this field.
description: |-
Identifies the version of a worker that received or processed a task
Deprecated. This message is replaced with `Deployment` and `VersioningBehavior`.
Deprecated. This message is replaced with `Deployment` and `VersioningBehavior`.
Identifies the version of a worker that received or processed a task
WorkflowEvent_EventReference:
type: object
properties:
Expand Down
7 changes: 1 addition & 6 deletions temporal/api/common/v1/message.proto
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ message MeteringMetadata {
uint32 nonfirst_local_activity_execution_attempts = 13;
}

// Identifies the version of a worker that received or processed a task
// Deprecated. This message is replaced with `Deployment` and `VersioningBehavior`.
// Identifies the version of a worker that received or processed a task
message WorkerVersionStamp {
// An opaque whole-worker identifier. Replaces the deprecated `binary_checksum` field when this
// message is included in requests which previously used that.
Expand All @@ -134,11 +134,6 @@ message WorkerVersionStamp {
// marker for workflow reset points and the BuildIDs search attribute.
bool use_versioning = 3;

// Must be sent if user has set a deployment series name (versioning-3).
// Deprecated. SDK should return `Deployment` in the requests to server instead of populating
// this field.
string deployment_series_name = 4;

// Later, may include bundle id that could be used for WASM and/or JS dynamically loadable bundles.
}

Expand Down
10 changes: 5 additions & 5 deletions temporal/api/workflowservice/v1/request_response.proto
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ message RespondWorkflowTaskCompletedRequest {
// always be set by SDKs. Workers opting into versioning will also set the `use_versioning`
// field to true. See message docstrings for more.
// Deprecated. Use `deployment` and `versioning_behavior` instead.
temporal.api.common.v1.WorkerVersionStamp worker_version_stamp = 10;
temporal.api.common.v1.WorkerVersionStamp worker_version_stamp = 10 [deprecated = true];
// Default versioning behavior that is set at worker server level.
// Protocol messages piggybacking on a WFT as a transport
repeated temporal.api.protocol.v1.Message messages = 11;
Expand Down Expand Up @@ -402,7 +402,7 @@ message RespondWorkflowTaskFailedRequest {
// always be set by SDKs. Workers opting into versioning will also set the `use_versioning`
// field to true. See message docstrings for more.
// Deprecated. Use `deployment` instead.
temporal.api.common.v1.WorkerVersionStamp worker_version = 8;
temporal.api.common.v1.WorkerVersionStamp worker_version = 8 [deprecated = true];
// Deployment info of the worker that completed this task. Must be present if user has set
// `WorkerDeploymentOptions` regardless of versioning being enabled or not.
temporal.api.deployment.v1.Deployment deployment = 9;
Expand Down Expand Up @@ -519,7 +519,7 @@ message RespondActivityTaskCompletedRequest {
// always be set by SDKs. Workers opting into versioning will also set the `use_versioning`
// field to true. See message docstrings for more.
// Deprecated. Use `deployment` instead.
temporal.api.common.v1.WorkerVersionStamp worker_version = 5;
temporal.api.common.v1.WorkerVersionStamp worker_version = 5 [deprecated = true];
// Deployment info of the worker that completed this task. Must be present if user has set
// `WorkerDeploymentOptions` regardless of versioning being enabled or not.
temporal.api.deployment.v1.Deployment deployment = 6;
Expand Down Expand Up @@ -560,7 +560,7 @@ message RespondActivityTaskFailedRequest {
// always be set by SDKs. Workers opting into versioning will also set the `use_versioning`
// field to true. See message docstrings for more.
// Deprecated. Use `deployment` instead.
temporal.api.common.v1.WorkerVersionStamp worker_version = 6;
temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];
// Deployment info of the worker that completed this task. Must be present if user has set
// `WorkerDeploymentOptions` regardless of versioning being enabled or not.
temporal.api.deployment.v1.Deployment deployment = 7;
Expand Down Expand Up @@ -607,7 +607,7 @@ message RespondActivityTaskCanceledRequest {
// always be set by SDKs. Workers opting into versioning will also set the `use_versioning`
// field to true. See message docstrings for more.
// Deprecated. Use `deployment` instead.
temporal.api.common.v1.WorkerVersionStamp worker_version = 5;
temporal.api.common.v1.WorkerVersionStamp worker_version = 5 [deprecated = true];
// Deployment info of the worker that completed this task. Must be present if user has set
// `WorkerDeploymentOptions` regardless of versioning being enabled or not.
temporal.api.deployment.v1.Deployment deployment = 6;
Expand Down

0 comments on commit 2bab1e0

Please sign in to comment.