From 2d226f1ccdd1e59d5bee82c77a08b208941469d1 Mon Sep 17 00:00:00 2001 From: Dan Davison Date: Thu, 21 Mar 2024 09:22:03 -0400 Subject: [PATCH 1/2] Document failover version --- openapi/openapiv2.json | 2 +- openapi/openapiv3.yaml | 4 +++- temporal/api/history/v1/message.proto | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index c7fba397..44b2877d 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -4570,7 +4570,7 @@ "version": { "type": "string", "format": "int64", - "title": "TODO: What is this? Appears unused by SDKs" + "description": "Failover version. Defines alternate history branches that can arise in multi-cluster\nconfigurations (e.g. multi-region namespaces)." }, "taskId": { "type": "string", diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index d0e15256..28380584 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -2965,7 +2965,9 @@ components: format: enum version: type: string - description: 'TODO: What is this? Appears unused by SDKs' + description: |- + Failover version. Defines alternate history branches that can arise in multi-cluster + configurations (e.g. multi-region namespaces). taskId: type: string description: 'TODO: What is this? Appears unused by SDKs' diff --git a/temporal/api/history/v1/message.proto b/temporal/api/history/v1/message.proto index da795e16..ac55a240 100644 --- a/temporal/api/history/v1/message.proto +++ b/temporal/api/history/v1/message.proto @@ -767,7 +767,8 @@ message HistoryEvent { int64 event_id = 1; google.protobuf.Timestamp event_time = 2; temporal.api.enums.v1.EventType event_type = 3; - // TODO: What is this? Appears unused by SDKs + // Failover version. Defines alternate history branches that can arise in multi-cluster + // configurations (e.g. multi-region namespaces). int64 version = 4; // TODO: What is this? Appears unused by SDKs int64 task_id = 5; From fea76aad80706748d47f0e557cd577fd07795cda Mon Sep 17 00:00:00 2001 From: Dan Davison Date: Thu, 21 Mar 2024 13:25:35 -0400 Subject: [PATCH 2/2] Specify that it's namespace failover version Co-authored-by: Roey Berman --- openapi/openapiv2.json | 2 +- openapi/openapiv3.yaml | 4 ++-- temporal/api/history/v1/message.proto | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index 44b2877d..12fe7040 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -4570,7 +4570,7 @@ "version": { "type": "string", "format": "int64", - "description": "Failover version. Defines alternate history branches that can arise in multi-cluster\nconfigurations (e.g. multi-region namespaces)." + "description": "Namespace failover version. Defines alternate history branches that can arise in\nmulti-cluster configurations (e.g. multi-region namespaces)." }, "taskId": { "type": "string", diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index 28380584..05d4a504 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -2966,8 +2966,8 @@ components: version: type: string description: |- - Failover version. Defines alternate history branches that can arise in multi-cluster - configurations (e.g. multi-region namespaces). + Namespace failover version. Defines alternate history branches that can arise in + multi-cluster configurations (e.g. multi-region namespaces). taskId: type: string description: 'TODO: What is this? Appears unused by SDKs' diff --git a/temporal/api/history/v1/message.proto b/temporal/api/history/v1/message.proto index ac55a240..1972be4e 100644 --- a/temporal/api/history/v1/message.proto +++ b/temporal/api/history/v1/message.proto @@ -767,8 +767,8 @@ message HistoryEvent { int64 event_id = 1; google.protobuf.Timestamp event_time = 2; temporal.api.enums.v1.EventType event_type = 3; - // Failover version. Defines alternate history branches that can arise in multi-cluster - // configurations (e.g. multi-region namespaces). + // Namespace failover version. Defines alternate history branches that can arise in + // multi-cluster configurations (e.g. multi-region namespaces). int64 version = 4; // TODO: What is this? Appears unused by SDKs int64 task_id = 5;