Skip to content

Commit a4669a5

Browse files
Rename metric_sample.proto to metrics.proto (#338)
This change renames the `metric_sample.proto` file to `metrics.proto` to better reflect its content. The file contains multiple metric-related messages, including `SimpleMetricValue` and `MetricSample`, which are used to represent metric values and samples, respectively. The new name `metrics.proto` is more descriptive and aligns with the purpose of the file.
2 parents c9a075d + 06b6f0c commit a4669a5

File tree

5 files changed

+8
-7
lines changed

5 files changed

+8
-7
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
- Remove unnecessary gap in numbering in the `ElectricalComponentCategory` enum.
2626
- Renumber variants in the `Metric` enum to remove unnecessary gaps.
2727
- Added a new enum `ElectricalComponentControlMode` to define control modes for electrical components.
28+
- Renamed `metric_sample.proto` to `metrics.proto` to better reflect its content.
2829

2930
## Bug Fixes
3031

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ syntax = "proto3";
1111
package frequenz.api.common.v1.microgrid.electrical_components;
1212

1313
import "frequenz/api/common/v1/metrics/bounds.proto";
14-
import "frequenz/api/common/v1/metrics/metric_sample.proto";
14+
import "frequenz/api/common/v1/metrics/metrics.proto";
1515
import "frequenz/api/common/v1/microgrid/electrical_components/battery.proto";
1616
import
1717
"frequenz/api/common/v1/microgrid/electrical_components/ev_charger.proto";

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ syntax = "proto3";
1010

1111
package frequenz.api.common.v1.microgrid.sensors;
1212

13-
import "frequenz/api/common/v1/metrics/metric_sample.proto";
13+
import "frequenz/api/common/v1/metrics/metrics.proto";
1414
import "frequenz/api/common/v1/microgrid/lifetime.proto";
1515

1616
import "google/protobuf/timestamp.proto";

pytests/test_common.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ def test_module_import_metrics_bounds() -> None:
3838
assert bounds_pb2_grpc is not None
3939

4040

41-
def test_module_import_metrics_metric_sample() -> None:
41+
def test_module_import_metrics_metrics() -> None:
4242
"""Test that the modules can be imported."""
4343
# pylint: disable=import-outside-toplevel
44-
from frequenz.api.common.v1.metrics import metric_sample_pb2
44+
from frequenz.api.common.v1.metrics import metrics_pb2
4545

46-
assert metric_sample_pb2 is not None
46+
assert metrics_pb2 is not None
4747

4848
# pylint: disable=import-outside-toplevel
49-
from frequenz.api.common.v1.metrics import metric_sample_pb2_grpc
49+
from frequenz.api.common.v1.metrics import metrics_pb2_grpc
5050

51-
assert metric_sample_pb2_grpc is not None
51+
assert metrics_pb2_grpc is not None
5252

5353

5454
def test_module_import_grid() -> None:

0 commit comments

Comments
 (0)