Skip to content

Add request IDs to activity update, unpause, and reset #844

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
fretz12 merged 6 commits into from
Jul 30, 2026
+48 −18
Merged

Add request IDs to activity update, unpause, and reset #844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dc3fc7f
Add request IDs to activity update, unpause, and reset
fretz12 Jul 29, 2026
a3d77b8
Address PR comments
fretz12 Jul 29, 2026
bbac65a
regen api
fretz12 Jul 29, 2026
c1dfa8c
shorten comment
fretz12 Jul 29, 2026
d9286b5
comment cleanup
fretz12 Jul 30, 2026
e33df82
Merge branch 'main' into fredtzeng/saa-req-id
fretz12 Jul 30, 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
24 changes: 18 additions & 6 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11731,7 +11731,7 @@
"properties": {
"runId": {
"type": "string",
"description": "Run ID of the workflow or standalone activity."
"description": "Run ID of the workflow or standalone activity. If empty, targets the latest run."
},
"identity": {
"type": "string",
Expand Down Expand Up @@ -11873,7 +11873,7 @@
"properties": {
"runId": {
"type": "string",
"description": "Activity run ID, targets the latest run if run_id is empty."
"description": "Activity run ID. If empty, targets the latest run."
},
"identity": {
"type": "string",
Expand Down Expand Up @@ -11995,7 +11995,7 @@
"properties": {
"runId": {
"type": "string",
"description": "Run ID of the workflow or standalone activity."
"description": "Run ID of the workflow or standalone activity. If empty, targets the latest run."
},
"identity": {
"type": "string",
Expand All @@ -12016,6 +12016,10 @@
"resourceId": {
"type": "string",
"description": "Resource ID for routing. Contains \"workflow:{workflow_id}\" for workflow activities or \"activity:{activity_id}\" for standalone activities."
},
"requestId": {
"type": "string",
"description": "Used to de-dupe reset requests."
}
}
},
Expand Down Expand Up @@ -12859,7 +12863,7 @@
"properties": {
"runId": {
"type": "string",
"description": "Activity run ID, targets the latest run if run_id is empty."
"description": "Activity run ID. If empty, targets the latest run."
},
"identity": {
"type": "string",
Expand Down Expand Up @@ -13001,7 +13005,7 @@
"properties": {
"runId": {
"type": "string",
"description": "Run ID of the workflow or standalone activity."
"description": "Run ID of the workflow or standalone activity. If empty, targets the latest run."
},
"identity": {
"type": "string",
Expand All @@ -13026,6 +13030,10 @@
"resourceId": {
"type": "string",
"description": "Resource ID for routing. Contains \"workflow:{workflow_id}\" for workflow activities or \"activity:{activity_id}\" for standalone activities."
},
"requestId": {
"type": "string",
"description": "Used to de-dupe unpause requests."
}
}
},
Expand Down Expand Up @@ -13055,7 +13063,7 @@
"properties": {
"runId": {
"type": "string",
"description": "Run ID of the workflow or standalone activity."
"description": "Run ID of the workflow or standalone activity. If empty, targets the latest run."
},
"identity": {
"type": "string",
Expand All @@ -13076,6 +13084,10 @@
"resourceId": {
"type": "string",
"description": "Resource ID for routing. Contains \"workflow:{workflow_id}\" for workflow activities or \"activity:{activity_id}\" for standalone activities."
},
"requestId": {
"type": "string",
"description": "Used to de-dupe update requests."
}
}
},
Expand Down
21 changes: 15 additions & 6 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14228,7 +14228,7 @@ components:
description: The ID of the activity to target.
runId:
type: string
description: Run ID of the workflow or standalone activity.
description: Run ID of the workflow or standalone activity. If empty, targets the latest run.
identity:
type: string
description: The identity of the client who initiated this request.
Expand Down Expand Up @@ -15269,7 +15269,7 @@ components:
type: string
runId:
type: string
description: Activity run ID, targets the latest run if run_id is empty.
description: Activity run ID. If empty, targets the latest run.
identity:
type: string
description: The identity of the worker/client.
Expand Down Expand Up @@ -15489,7 +15489,7 @@ components:
description: The ID of the activity to target.
runId:
type: string
description: Run ID of the workflow or standalone activity.
description: Run ID of the workflow or standalone activity. If empty, targets the latest run.
identity:
type: string
description: The identity of the client who initiated this request.
Expand All @@ -15511,6 +15511,9 @@ components:
resourceId:
type: string
description: Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
requestId:
type: string
description: Used to de-dupe reset requests.
ResetActivityExecutionResponse:
type: object
properties: {}
Expand Down Expand Up @@ -17849,7 +17852,7 @@ components:
type: string
runId:
type: string
description: Activity run ID, targets the latest run if run_id is empty.
description: Activity run ID. If empty, targets the latest run.
identity:
type: string
description: The identity of the worker/client.
Expand Down Expand Up @@ -18165,7 +18168,7 @@ components:
description: The ID of the activity to target.
runId:
type: string
description: Run ID of the workflow or standalone activity.
description: Run ID of the workflow or standalone activity. If empty, targets the latest run.
identity:
type: string
description: The identity of the client who initiated this request.
Expand All @@ -18185,6 +18188,9 @@ components:
resourceId:
type: string
description: Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
requestId:
type: string
description: Used to de-dupe unpause requests.
UnpauseActivityExecutionResponse:
type: object
properties: {}
Expand Down Expand Up @@ -18266,7 +18272,7 @@ components:
description: The ID of the activity to target.
runId:
type: string
description: Run ID of the workflow or standalone activity.
description: Run ID of the workflow or standalone activity. If empty, targets the latest run.
identity:
type: string
description: The identity of the client who initiated this request
Expand All @@ -18289,6 +18295,9 @@ components:
resourceId:
type: string
description: Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.
requestId:
type: string
description: Used to de-dupe update requests.
UpdateActivityExecutionOptionsResponse:
type: object
properties:
Expand Down
21 changes: 15 additions & 6 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 @@ -2186,7 +2186,7 @@ message UpdateActivityExecutionOptionsRequest {
string workflow_id = 2;
// The ID of the activity to target.
string activity_id = 3;
// Run ID of the workflow or standalone activity.
// Run ID of the workflow or standalone activity. If empty, targets the latest run.
string run_id = 4;
Comment on lines +2189 to 2190

@dandavison dandavison Jul 29, 2026 •
edited
Loading

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 think it's hard to explain and the comment risks making it more confusing, not less. (what is "retrying"?) I vote we just follow SANO and keep it to

Suggested change
// Run ID of the workflow or standalone activity. If empty, targets the latest run.
// For standalone activities, specify a run ID to avoid retrying a different
// execution when the activity ID is reused.
string run_id = 4;
// Run ID of the workflow or standalone activity. If empty, targets the latest run.
string run_id = 4;

@fretz12 fretz12 Jul 29, 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.

yea it's hard to explain a corner in a field doc. I'll simplify


// The identity of the client who initiated this request
Expand All @@ -2207,6 +2207,9 @@ message UpdateActivityExecutionOptionsRequest {

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

// Used to de-dupe update requests.
string request_id = 10;
}

// Deprecated. Use `UpdateActivityExecutionOptionsResponse`.
Expand Down Expand Up @@ -2256,7 +2259,7 @@ message PauseActivityExecutionRequest {
string workflow_id = 2;
// The ID of the activity to target.
string activity_id = 3;
// Run ID of the workflow or standalone activity.
// Run ID of the workflow or standalone activity. If empty, targets the latest run.
string run_id = 4;

// The identity of the client who initiated this request.
Expand Down Expand Up @@ -2318,7 +2321,7 @@ message UnpauseActivityExecutionRequest {
string workflow_id = 2;
// The ID of the activity to target.
string activity_id = 3;
// Run ID of the workflow or standalone activity.
// Run ID of the workflow or standalone activity. If empty, targets the latest run.
string run_id = 4;

// The identity of the client who initiated this request.
Expand All @@ -2338,6 +2341,9 @@ message UnpauseActivityExecutionRequest {

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

// Used to de-dupe unpause requests.
string request_id = 11;
}

// Deprecated. Use `UnpauseActivityExecutionResponse`.
Expand Down Expand Up @@ -2394,7 +2400,7 @@ message ResetActivityExecutionRequest {
string workflow_id = 2;
// The ID of the activity to target.
string activity_id = 3;
// Run ID of the workflow or standalone activity.
// Run ID of the workflow or standalone activity. If empty, targets the latest run.
string run_id = 4;

// The identity of the client who initiated this request.
Expand All @@ -2414,6 +2420,9 @@ message ResetActivityExecutionRequest {

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

// Used to de-dupe reset requests.
string request_id = 10;
}

// Deprecated. Use `ResetActivityExecutionRequest`.
Expand Down Expand Up @@ -3559,7 +3568,7 @@ message CountNexusOperationExecutionsResponse {
message RequestCancelActivityExecutionRequest {
string namespace = 1;
string activity_id = 2;
// Activity run ID, targets the latest run if run_id is empty.
// Activity run ID. If empty, targets the latest run.

@spkane31 spkane31 Jul 30, 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.

For consistency, do you want to remove the "Specify a run ID to avoid retrying ...." from RequestCancel and Terminate?

@fretz12 fretz12 Jul 30, 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.

Agreed, removed

string run_id = 3;
// The identity of the worker/client.
string identity = 4;
Expand All @@ -3576,7 +3585,7 @@ message RequestCancelActivityExecutionResponse {
message TerminateActivityExecutionRequest {
string namespace = 1;
string activity_id = 2;
// Activity run ID, targets the latest run if run_id is empty.
// Activity run ID. If empty, targets the latest run.
string run_id = 3;
// The identity of the worker/client.
string identity = 4;
Expand Down
Loading