Skip to content

Deprecate BatchOperationResetActivities.reset_attempts - #878

Open
ks-temporal wants to merge 2 commits into
mainfrom
ks/reset_attempts_deprecate
Open

ks-temporal wants to merge 2 commits into
mainfrom
ks/reset_attempts_deprecate

Conversation

@ks-temporal

Copy link
Copy Markdown
Contributor

What changed?
Marked BatchOperationResetActivities.reset_attempts as deprecated, documenting that it is
not supported.

Why?
The field cannot be honored:

  • temporal.api.workflowservice.v1.ResetActivityRequest, which this message mirrors (see the
    NOTE above the message), has no equivalent field, so there is nothing to carry the flag to the
    server.
  • The server's reset always resets the attempt count, so a false value has no effect.
  • ResetActivityExecutionRequest, the newer reset API, already reserves the name rather than
    defining it.

Breaking changes
None.

The ResetActivityRequest has no equivalent field, and the server always
resets the attempt count. A false value has no effect.
@ks-temporal
ks-temporal marked this pull request as ready for review October 2, 2026 22:16
@ks-temporal
ks-temporal requested review from a team and a balanced review from Copilot October 2, 2026 22:17

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The changes consistently document the unsupported flag without changing its field number, type, or runtime behavior.

Review effort: Balanced
Findings: None

What changed in this PR

Deprecates the unsupported BatchOperationResetActivities.reset_attempts field while preserving compatibility.

Changes:

  • Adds the protobuf deprecation marker and explains why the flag is ignored.
  • Updates both OpenAPI descriptions to match.
File Description
temporal/​api/​batch/​v1/​message.proto Deprecates and documents the unsupported field.
openapi/​openapiv3.yaml Updates the field description.
openapi/​openapiv2.json Updates the field description.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants