Rename MetricSampleVariant to MetricValueVariant

This variants present in this enum are not called samples anymore, but values. Signed-off-by: Tiyash Basu <[email protected]>
frequenz-floss · Mar 22, 2024 · fbcc68b · fbcc68b
1 parent cb6cc75
commit fbcc68b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -36,6 +36,8 @@
 - Renamed `AggregatedMetricSample` to `AggregatedMetricValue`, because it does not
   contain a timestamp, so it does not represent a sample but a value.
 
+- Renamed `MetricSampleVariant` to `MetricValueVariant`.
+
 ## New Features
 
 - Added a `Frequenz.api.common.v1.types.Decimal` type, compatible with

diff --git a/proto/frequenz/api/common/v1/metrics/metric_sample.proto b/proto/frequenz/api/common/v1/metrics/metric_sample.proto
@@ -45,18 +45,18 @@ message AggregatedMetricValue {
   repeated float raw_values = 5;
 }
 
-// MetricSampleVariant serves as a union type that can encapsulate either a
+// `MetricValueVariant` serves as a union type that can encapsulate either a
 // `SimpleMetricValue` or an `AggregatedMetricValue`.
 //
 // This message is designed to offer flexibility in capturing different
 // granularities of metric samples—either a simple single-point measurement
 // or an aggregated set of measurements for a metric.
 //
-// A `MetricSampleVariant` can hold either a `SimpleMetricValue` or an
+// A `MetricValueVariant` can hold either a `SimpleMetricValue` or an
 // `AggregatedMetricValue`, but not both simultaneously. Setting one will
 // nullify the other.
-message MetricSampleVariant {
-  oneof metric_sample_type {
+message MetricValueVariant {
+  oneof metric_value_variant {
     SimpleMetricValue simple_metric = 1;
     AggregatedMetricValue aggregated_metric = 2;
   }
@@ -178,7 +178,7 @@ message MetricSample {
   Metric metric = 2;
 
   // The value of the sampled metric.
-  MetricSampleVariant sample = 3;
+  MetricValueVariant sample = 3;
 
   // List of bounds that apply to the metric sample.
   //

diff --git a/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto b/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto
@@ -120,12 +120,12 @@ enum SensorMetric {
 //        {
 //          sampled_at: "2023-10-01T00:00:00Z",
 //          metric: "METRIC_SENSOR_TEMPERATURE",
-//          sample: metric_sample_type: {simple_metric: {value: 23.5},
+//          sample: metric_value_variant: {simple_metric: {value: 23.5},
 //        },
 //        {
 //          sampled_at: "2023-10-01T00:00:00Z",
 //          metric: "METRIC_SENSOR_RELATIVE_HUMIDITY",
-//          sample: metric_sample_type: {simple_metric: {value: 23.5},
+//          sample: metric_value_variant: {simple_metric: {value: 23.5},
 //        }
 //      ],
 //      states: [
@@ -209,5 +209,5 @@ message SensorMetricSample {
   frequenz.api.common.v1.metrics.Metric metric = 2;
 
   // The value of the sampled metric.
-  frequenz.api.common.v1.metrics.MetricSampleVariant sample = 3;
+  frequenz.api.common.v1.metrics.MetricValueVariant sample = 3;
 }