Skip to content

Commit 2d226f1

Browse files
committed
Document failover version
1 parent c43384d commit 2d226f1

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

openapi/openapiv2.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4570,7 +4570,7 @@
45704570
"version": {
45714571
"type": "string",
45724572
"format": "int64",
4573-
"title": "TODO: What is this? Appears unused by SDKs"
4573+
"description": "Failover version. Defines alternate history branches that can arise in multi-cluster\nconfigurations (e.g. multi-region namespaces)."
45744574
},
45754575
"taskId": {
45764576
"type": "string",

openapi/openapiv3.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -2965,7 +2965,9 @@ components:
29652965
format: enum
29662966
version:
29672967
type: string
2968-
description: 'TODO: What is this? Appears unused by SDKs'
2968+
description: |-
2969+
Failover version. Defines alternate history branches that can arise in multi-cluster
2970+
configurations (e.g. multi-region namespaces).
29692971
taskId:
29702972
type: string
29712973
description: 'TODO: What is this? Appears unused by SDKs'

temporal/api/history/v1/message.proto

+2-1
Original file line numberDiff line numberDiff line change
@@ -767,7 +767,8 @@ message HistoryEvent {
767767
int64 event_id = 1;
768768
google.protobuf.Timestamp event_time = 2;
769769
temporal.api.enums.v1.EventType event_type = 3;
770-
// TODO: What is this? Appears unused by SDKs
770+
// Failover version. Defines alternate history branches that can arise in multi-cluster
771+
// configurations (e.g. multi-region namespaces).
771772
int64 version = 4;
772773
// TODO: What is this? Appears unused by SDKs
773774
int64 task_id = 5;

0 commit comments

Comments
 (0)