Skip to content

Rename Timestamp fields to follow Protobuf guidelines #241

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

Merged
Marenz merged 1 commit into from
Apr 23, 2025
Merged

Rename Timestamp fields to follow Protobuf guidelines #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ This update introduces the possibility to target specific types of batteries, in

* In the `TargetComponents` message, the field `components.component_categories` is now deprecated. See the upgrading section for details.

## Changes

* Renamed several `google.protobuf.Timestamp` fields in Protobuf messages to align with Google API Design Guide naming conventions (`*_time` suffix):
* `DispatchMetadata.modification_time` is now `update_time`.
* `TimeIntervalFilter.from` is now `from_time`.
* `TimeIntervalFilter.to` is now `to_time`.
* `RecurrenceRule.EndCriteria.until` is now `until_time`.
* **Note:** This is a breaking change for clients using the old field names.

## Upgrading

* The `TargetComponents` message now accepts an optional `type` too. `.components.component_categories` is now deprecated. Instead `.components.component_categories_types`, a new `CategoryAndType` message that has a required `category` (`ComponentCategory`) and an optional `type` (`oneof BatteryType, EVChargerType, InverterType`) should be used.
Expand Down
14 changes: 7 additions & 7 deletions proto/frequenz/api/dispatch/v1/dispatch.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,8 @@ message DispatchMetadata {
// UTC Timestamp when the order was created.
google.protobuf.Timestamp create_time = 2;

// UTC Timestamp of the last update to the order.
google.protobuf.Timestamp modification_time = 3;
// UTC time of the last update to the order.
google.protobuf.Timestamp update_time = 3;

// UTC Timestamp when the dispatch will stop working.
// Will be calculated internally based on the given: start_time,
Expand All @@ -206,11 +206,11 @@ message DispatchMetadata {

// Filter parameter for specifying multiple time intervals
message TimeIntervalFilter {
// Filter by time >= this UTC timestamp.
google.protobuf.Timestamp from = 1;
// Filter by time >= this UTC time.
google.protobuf.Timestamp from_time = 1;

// Filter by time <= this UTC timestamp.
google.protobuf.Timestamp to = 2;
// Filter by time <= this UTC time.
google.protobuf.Timestamp to_time = 2;
}

// Parameters for filtering the dispatch list
Expand Down Expand Up @@ -476,7 +476,7 @@ message RecurrenceRule {
// timestamp.
// Note that the duration of the event is not considered in this value,
// so the dispatch may end after the timestamp.
google.protobuf.Timestamp until = 2;
google.protobuf.Timestamp until_time = 2;
}
}

Expand Down
Loading