Skip to content

Commit 0c89fbb

Browse files
Update documentation for origin_time field in proto files
Signed-off-by: Tiyash Basu <[email protected]>
1 parent 778d70b commit 0c89fbb

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ message CommunicationComponentDiagnostic {
173173
// in time, so there is only a single `snapshot_time`. any parallel reads
174174
// happening to produce this data are collapsed under that timestamp.
175175
message CommunicationComponentStateSnapshot {
176-
// the UTC time when this snapshot was taken.
176+
// The UTC time when the state was originally captured.
177177
google.protobuf.Timestamp snapshot_time = 1;
178178

179179
// one or more high-level state codes active at snapshot_time.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ message ElectricalComponentDiagnostic {
475475

476476
// Representation of a component state, warnings, and errors.
477477
message ElectricalComponentStateSnapshot {
478-
// The time at which the state was sampled.
478+
// The UTC time when the state was originally captured.
479479
google.protobuf.Timestamp origin_time = 1;
480480

481481

@@ -524,13 +524,13 @@ message ElectricalComponentStateSnapshot {
524524
// metric_samples: [
525525
// /* list of metrics for multiple timestamps */
526526
// {
527-
// sampled_time: "2023-10-01T00:00:00Z",
527+
// sampled_at: "2023-10-01T00:00:00Z",
528528
// metric: "DC_VOLTAGE_V",
529529
// value: {},
530530
// bounds: {},
531531
// },
532532
// {
533-
// sampled_time: "2023-10-01T00:00:00Z",
533+
// sampled_at: "2023-10-01T00:00:00Z",
534534
// metric: "DC_VOLTAGE_V",
535535
// value: {},
536536
// bounds: {},
@@ -539,13 +539,13 @@ message ElectricalComponentStateSnapshot {
539539
// states: [
540540
// /* list of states for multiple timestamps */
541541
// {
542-
// sampled_time: "2023-10-01T00:00:00Z",
542+
// sampled_at: "2023-10-01T00:00:00Z",
543543
// states: [],
544544
// warnings: [],
545545
// errors: [],
546546
// },
547547
// {
548-
// sampled_time: "2023-10-01T00:00:00Z",
548+
// sampled_at: "2023-10-01T00:00:00Z",
549549
// states: [],
550550
// warnings: [],
551551
// errors: [],

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ message SensorDiagnostic {
169169

170170
// Representation of a sensor state and errors.
171171
message SensorStateSnapshot {
172-
// The time at which the state was sampled.
172+
// The UTC time when the state was originally captured.
173173
google.protobuf.Timestamp origin_time = 1;
174174

175175
// List of states of the microgrid sensor.

0 commit comments

Comments
 (0)