Skip to content

Commit 3d0aa69

Browse files
authored
Improve the Lifetime message documentation (#259)
Make the specification of what `Lifetime` message is used for as clear and precise as possible. Fixes #250.
2 parents ca56060 + cf667ca commit 3d0aa69

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

proto/frequenz/api/common/v1/microgrid/lifetime.proto

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,27 @@ import "google/protobuf/timestamp.proto";
1515
// a microgrid asset, such as a component, connection, sensor, or any other
1616
// entity with a limited operational lifetime.
1717
//
18-
// !!! warning "Permanent Deletion"
19-
// The `end_timestamp` indicates that the asset has been permanently removed
20-
// from the system.
18+
// It is normally used to track the historical evolution of assets, and it
19+
// determines the validity period for the asset's data.
2120
//
21+
// If the `start_timestamp` is not set, the asset is considered to be in
22+
// operation since the beginning of the system's operational history.
23+
//
24+
// If the `end_timestamp` is not set, the asset is considered to be in
25+
// operation indefinitely into the future.
26+
//
27+
// If the Lifetime message is completely missing, it means both timestamps are
28+
// not set, which means the asset is considered to be in operation since the
29+
// beginning of the system's operational history and indefinitely into the
30+
// future.
2231
message Lifetime {
2332
// The timestamp when the asset became operationally active.
33+
// If not set, the asset is considered to be in operation since the beginning
34+
// of the system's operational history.
2435
google.protobuf.Timestamp start_timestamp = 1;
2536

2637
// Optional timestamp when the asset's operational activity ceased.
38+
// If not set, the asset is considered to be in operation indefinitely into
39+
// the future.
2740
google.protobuf.Timestamp end_timestamp = 2;
2841
}

0 commit comments

Comments
 (0)