Skip to content

Keep VersionSummary and VersionLocalState in sync #582

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Keep VersionSummary and VersionLocalState in sync #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07dcfaa
required timestamps to be emitted from deploymentStateInfo
Shivs11 May 1, 2025
2a65140
Merge branch 'master' into ss/sync_version_summary_version_state
Shivs11 May 7, 2025
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
22 changes: 21 additions & 1 deletion openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7008,7 +7008,27 @@
"format": "date-time"
},
"drainageStatus": {
"$ref": "#/definitions/v1VersionDrainageStatus"
"$ref": "#/definitions/v1VersionDrainageStatus",
"description": "Deprecated. Use `drainage_info` instead."
},
"drainageInfo": {
"$ref": "#/definitions/v1VersionDrainageInfo",
"title": "Information about workflow drainage to help the user determine when it is safe\nto decommission a Version. Not present while version is current or ramping"
},
"currentSinceTime": {
"type": "string",
"format": "date-time",
"description": "Nil if not current."
},
"rampingSinceTime": {
"type": "string",
"format": "date-time",
"description": "Nil if not ramping. Updated when the version first starts ramping, not on each ramp change."
},
"routingUpdateTime": {
"type": "string",
"format": "date-time",
"description": "Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed."
}
}
},
Expand Down
25 changes: 25 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12056,7 +12056,32 @@ components:
- VERSION_DRAINAGE_STATUS_DRAINING
- VERSION_DRAINAGE_STATUS_DRAINED
type: string
description: Deprecated. Use `drainage_info` instead.
format: enum
drainageInfo:
allOf:
- $ref: '#/components/schemas/VersionDrainageInfo'
description: |-
Information about workflow drainage to help the user determine when it is safe
to decommission a Version. Not present while version is current or ramping
currentSinceTime:
type: string
description: |-
Nil if not current.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
format: date-time
rampingSinceTime:
type: string
description: |-
Nil if not ramping. Updated when the version first starts ramping, not on each ramp change.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
format: date-time
routingUpdateTime:
type: string
description: Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed.
format: date-time
WorkerDeploymentOptions:
type: object
properties:
Expand Down
14 changes: 14 additions & 0 deletions temporal/api/deployment/v1/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,21 @@ message WorkerDeploymentInfo {
// The fully-qualified string representation of the version, in the form "<deployment_name>.<build_id>".
string version = 1;
google.protobuf.Timestamp create_time = 2;
// Deprecated. Use `drainage_info` instead.
enums.v1.VersionDrainageStatus drainage_status = 3;
// Information about workflow drainage to help the user determine when it is safe
// to decommission a Version. Not present while version is current or ramping
VersionDrainageInfo drainage_info = 4;
// Nil if not current.
// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
google.protobuf.Timestamp current_since_time = 5;
// Nil if not ramping. Updated when the version first starts ramping, not on each ramp change.
// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
google.protobuf.Timestamp ramping_since_time = 6;
// Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed.
google.protobuf.Timestamp routing_update_time = 7;
}
}

Expand Down
Loading