Skip to content

Commit 734ce9d

Browse files
committed
update attempt comment
1 parent 6206c0c commit 734ce9d

4 files changed

Lines changed: 16 additions & 9 deletions

File tree

openapi/openapiv2.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15820,7 +15820,7 @@
1582015820
"attempt": {
1582115821
"type": "integer",
1582215822
"format": "int32",
15823-
"description": "The number of attempts made to start/deliver the operation request.\nThis number represents a minimum bound since the attempt is incremented after the request completes."
15823+
"description": "The number of attempts made to deliver the start operation request.\nThis number is approximate, it is incremented when a task is added to the history queue.\nIn practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task\nwas never executed."
1582415824
},
1582515825
"scheduleTime": {
1582615826
"type": "string",
@@ -16368,7 +16368,7 @@
1636816368
"attempt": {
1636916369
"type": "integer",
1637016370
"format": "int32",
16371-
"description": "The number of attempts made to deliver the start operation request.\nThis number represents a minimum bound since the attempt is incremented after the request completes."
16371+
"description": "The number of attempts made to deliver the start operation request.\nThis number is approximate, it is incremented when a task is added to the history queue.\nIn practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task\nwas never executed."
1637216372
},
1637316373
"lastAttemptCompleteTime": {
1637416374
"type": "string",

openapi/openapiv3.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12408,8 +12408,10 @@ components:
1240812408
attempt:
1240912409
type: integer
1241012410
description: |-
12411-
The number of attempts made to start/deliver the operation request.
12412-
This number represents a minimum bound since the attempt is incremented after the request completes.
12411+
The number of attempts made to deliver the start operation request.
12412+
This number is approximate, it is incremented when a task is added to the history queue.
12413+
In practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task
12414+
was never executed.
1241312415
format: int32
1241412416
scheduleTime:
1241512417
type: string
@@ -13003,7 +13005,9 @@ components:
1300313005
type: integer
1300413006
description: |-
1300513007
The number of attempts made to deliver the start operation request.
13006-
This number represents a minimum bound since the attempt is incremented after the request completes.
13008+
This number is approximate, it is incremented when a task is added to the history queue.
13009+
In practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task
13010+
was never executed.
1300713011
format: int32
1300813012
lastAttemptCompleteTime:
1300913013
type: string

temporal/api/nexus/v1/message.proto

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,10 @@ message NexusOperationExecutionInfo {
276276
// aip.dev/not-precedent: "to" is used to indicate interval. --)
277277
google.protobuf.Duration start_to_close_timeout = 10;
278278

279-
// The number of attempts made to start/deliver the operation request.
280-
// This number represents a minimum bound since the attempt is incremented after the request completes.
279+
// The number of attempts made to deliver the start operation request.
280+
// This number is approximate, it is incremented when a task is added to the history queue.
281+
// In practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task
282+
// was never executed.
281283
int32 attempt = 11;
282284

283285
// Time the operation was originally scheduled via a StartNexusOperation request.

temporal/api/workflow/v1/message.proto

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,9 @@ message PendingNexusOperationInfo {
515515
temporal.api.enums.v1.PendingNexusOperationState state = 7;
516516

517517
// The number of attempts made to deliver the start operation request.
518-
// This number represents a minimum bound since the attempt is incremented after the request completes.
518+
// This number is approximate, it is incremented when a task is added to the history queue.
519+
// In practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task
520+
// was never executed.
519521
int32 attempt = 8;
520522

521523
// The time when the last attempt completed.
@@ -753,4 +755,3 @@ message WorkflowExecutionPauseInfo {
753755
// The reason for pausing the workflow execution.
754756
string reason = 3;
755757
}
756-

0 commit comments

Comments
 (0)