Skip to content

Commit f850e76

Browse files
Clarify timestamp docs, that timestamps are all in UTC.
Fixes #61 Signed-off-by: Stefan Brus <[email protected]>
1 parent 050c2da commit f850e76

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

proto/frequenz/dispatch/v1/dispatch.proto

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,10 @@ service MicrogridDispatchService {
6565
rpc DeleteMicrogridDispatch(DispatchDeleteRequest) returns (google.protobuf.Empty);
6666
}
6767

68-
// Message representing one dispatch
68+
// Message representing one dispatch.
69+
//
70+
// Timezone Note: Timestamps are in UTC. It is the responsibility of each microgrid to translate UTC
71+
// to its local timezone.
6972
message Dispatch {
7073
// The dispatch identifier
7174
uint64 id = 1;
@@ -79,18 +82,18 @@ message Dispatch {
7982
// understanding and processing this field.
8083
string type = 3;
8184

82-
// The creation time
85+
// The creation time in UTC
8386
// This is set when a dispatch is created via the create request message
8487
google.protobuf.Timestamp create_time = 4;
8588

86-
// The update time
89+
// The update time in UTC
8790
// This is set when a dispatch is modified via the update request message
8891
google.protobuf.Timestamp update_time = 5;
8992

90-
// The start time
93+
// The start time in UTC
9194
google.protobuf.Timestamp start_time = 6;
9295

93-
// The end time
96+
// The end time in UTC
9497
google.protobuf.Timestamp end_time = 7;
9598

9699
// The component selector
@@ -152,7 +155,10 @@ message DispatchComponentIDs {
152155
repeated uint64 component_ids = 1;
153156
}
154157

155-
// Ruleset governing when and how a dispatch should re-occur
158+
// Ruleset governing when and how a dispatch should re-occur.
159+
//
160+
// Timezone Note: Timestamps are in UTC. It is the responsibility of each microgrid to translate UTC
161+
// to its local timezone.
156162
//
157163
// This definition tries to adhere closely to the iCalendar specification (RFC 5545),
158164
// particularly for recurrence rules. For advanced use-cases or further clarifications,

0 commit comments

Comments
 (0)