Skip to content

remove reset_heartbeats field in ResetActivityExecutionRequest #820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spkane31 merged 2 commits into from
Jul 14, 2026
+16 −17
Merged

remove reset_heartbeats field in ResetActivityExecutionRequest #820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e4f568
remove reset_heartbeats field in ResetActivityExecutionRequest
spkane31 Jul 7, 2026
3e0aa8e
Merge branch 'main' of github.com:temporalio/api into spk/remove-keep…
spkane31 Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions buf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ breaking:
- WIRE_JSON
ignore:
- google
ignore_only:

@fretz12 fretz12 Jul 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

if we did my above comment, I don't think we need this

@spkane31 spkane31 Jul 14, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Agree we can swap, but since this has never been used server side I think it is cleaner to remove

# TODO(seankane): Remove these temporary breaking-change ignores after this PR merges.
FIELD_SAME_JSON_NAME:
- temporal/api/workflowservice/v1/request_response.proto
FIELD_SAME_NAME:
- temporal/api/workflowservice/v1/request_response.proto
FIELD_WIRE_JSON_COMPATIBLE_TYPE:
- temporal/api/workflowservice/v1/request_response.proto
FIELD_NO_DELETE_UNLESS_NAME_RESERVED:
- temporal/api/workflowservice/v1/request_response.proto
FIELD_NO_DELETE_UNLESS_NUMBER_RESERVED:
- temporal/api/workflowservice/v1/request_response.proto
lint:
use:
- DEFAULT
Expand Down
4 changes: 0 additions & 4 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11747,10 +11747,6 @@
"type": "string",
"description": "The identity of the client who initiated this request."
},
"resetHeartbeat": {
"type": "boolean",
"description": "Indicates that activity should reset heartbeat details.\nThis flag will be applied only to the new instance of the activity."
},
"keepPaused": {
"type": "boolean",
"title": "If activity is paused, it will remain paused after reset"
Expand Down
5 changes: 0 additions & 5 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15112,11 +15112,6 @@ components:
identity:
type: string
description: The identity of the client who initiated this request.
resetHeartbeat:
type: boolean
description: |-
Indicates that activity should reset heartbeat details.
This flag will be applied only to the new instance of the activity.
keepPaused:
type: boolean
description: If activity is paused, it will remain paused after reset
Expand Down
12 changes: 4 additions & 8 deletions temporal/api/workflowservice/v1/request_response.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2386,24 +2386,20 @@ message ResetActivityExecutionRequest {
// The identity of the client who initiated this request.
string identity = 5;

// Indicates that activity should reset heartbeat details.
// This flag will be applied only to the new instance of the activity.
bool reset_heartbeat = 6;

// If activity is paused, it will remain paused after reset
bool keep_paused = 7;
bool keep_paused = 6;

@fretz12 fretz12 Jul 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm assuming swapping is ok if no one uses this API?
Safe thing to do is:

    reserved 6;
    reserved "reset_heartbeat";

    // If activity is paused, it will remain paused after reset
    bool keep_paused = 7;
...

@dandavison dandavison Jul 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Agree it's OK to renumber: ResetActivityExecutionRequest has always returned an error.


// If set, and activity is in backoff, the activity will start at a random time within the specified jitter duration.
// (unless it is paused and keep_paused is set)
google.protobuf.Duration jitter = 8;
google.protobuf.Duration jitter = 7;

// If set, the activity options will be restored to the defaults.
// Default options are then options activity was created with.
// They are part of the first schedule event.
bool restore_original_options = 9;
bool restore_original_options = 8;

// Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
string resource_id = 10;
string resource_id = 9;
}

// Deprecated. Use `ResetActivityExecutionRequest`.
Expand Down
Loading