Repository navigation
Deprecate Versioning APIs previous_* response fields - #669
Merged
Merged
Conversation
ShahabT
commented
Nov 24, 2025
| // Current version info before calling this API. By passing the `conflict_token` got from the | ||
| // `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes | ||
| // between the two calls. | ||
| temporal.api.deployment.v1.WorkerDeploymentVersion previous_deployment_version = 3 [deprecated = true]; |
Contributor
Author
There was a problem hiding this comment.
@Sushisource these fields have flaky behavior which has been issue with server test. I don't think we should've added them in the first place.
I checked sdk-go and it doesn't seem we're verifying the field for real so it's good, but we need to mark it as deprecated in the Go response struct as well. Happy to send that PR too if you give a 👍
Member
There was a problem hiding this comment.
SGTM. I can't find it being used.
Shivs11
approved these changes
Nov 25, 2025
Shivs11
left a comment
Shivs11
left a comment
Member
There was a problem hiding this comment.
I think there may be some server changes though (like removing this field when we build out the response struct in the frontend)
Sushisource
approved these changes
Nov 25, 2025
Contributor
Author
|
@Shivs11 those changes we do at a later point for now we want to mark it as deprecated but still populate it. |
stephanos
pushed a commit
that referenced
this pull request
Mar 10, 2026
_**READ BEFORE MERGING:** All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted._ <!-- Describe what has changed in this PR --> Deprecating the following fields in favor of API idempotency. - `SetWorkerDeploymentCurrentVersionResponse.previous_deployment_version` - `SetWorkerDeploymentRampingVersionResponse.previous_deployment_version` - `SetWorkerDeploymentRampingVersionResponse.previous_percentage` - `SetWorkerDeploymentManagerResponse.previous_manager_identity` <!-- Tell your future self why have you made these changes --> The fields do not fit well with these idempotent APIs. They will return invalid results when the API is retried by server or client. Users who need this info can use `DescribeWorkerDeployment` before calling this the `Set*` APIs. By passing the `conflict_token` got from the `DescribeWorkerDeployment` call to the Set API they can ensure there is no interfering changes between the two calls. <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** These fields are deprecated and will stop being populated sometime after Versioning GA. <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> **Server PR** No server change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
READ BEFORE MERGING: All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted.
Deprecating the following fields in favor of API idempotency.
SetWorkerDeploymentCurrentVersionResponse.previous_deployment_versionSetWorkerDeploymentRampingVersionResponse.previous_deployment_versionSetWorkerDeploymentRampingVersionResponse.previous_percentageSetWorkerDeploymentManagerResponse.previous_manager_identityThe fields do not fit well with these idempotent APIs. They will return invalid results when the API is retried by server or client.
Users who need this info can use
DescribeWorkerDeploymentbefore calling this theSet*APIs. By passing theconflict_tokengot from theDescribeWorkerDeploymentcall to the Set API they can ensure there is no interfering changes between the two calls.Breaking changes
These fields are deprecated and will stop being populated sometime after Versioning GA.
Server PR
No server change.