Skip to content
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.

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

Document failover version #377

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion openapi/openapiv2.json
Original file line number Diff line number Diff line change
Expand Up @@ -4570,7 +4570,7 @@
"version": {
"type": "string",
"format": "int64",
"title": "TODO: What is this? Appears unused by SDKs"
"description": "Namespace failover version. Defines alternate history branches that can arise in\nmulti-cluster configurations (e.g. multi-region namespaces)."
},
"taskId": {
"type": "string",
Expand Down
4 changes: 3 additions & 1 deletion openapi/openapiv3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2965,7 +2965,9 @@ components:
format: enum
version:
type: string
description: 'TODO: What is this? Appears unused by SDKs'
description: |-
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'
Expand Down
3 changes: 2 additions & 1 deletion temporal/api/history/v1/message.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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
// Namespace failover version. Defines alternate history branches that can arise in
// multi-cluster configurations (e.g. multi-region namespaces).
Comment on lines +770 to +771
Copy link
Member

Choose a reason for hiding this comment

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

Sorry for not catching this earlier.
We refer to them global namespaces not multi-region so might want to adjust.

Suggested change
// Namespace 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. global namespaces).

int64 version = 4;
// TODO: What is this? Appears unused by SDKs
int64 task_id = 5;
Expand Down
Loading