Update the docs for reporting errors for components

Signed-off-by: Tiyash Basu <[email protected]>

Author: tiyash-basu-frequenz

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

@@ -503,7 +503,13 @@ message ElectricalComponentState {
   // List of operational states currently active for the component.
   //
   // !!! note
-  //     The list must not contain duplicate state codes.
+  //    The list will contain unique members. No state will exist twice in
+  //    this list.
+  //
+  // !!! note
+  //    If the state is `ELECTRICAL_COMPONENT_STATE_CODE_ERROR`, then the
+  //    electrical component is in an error state. In such cases, the `errors`
+  //    field will be populated with the list of errors.
   repeated ElectricalComponentStateCode states = 2;
 
   // List of non-critical warnings detected for the component.
@@ -516,6 +522,10 @@ message ElectricalComponentState {
   // List of critical errors currently affecting the component.
   //
   // !!! note
+  //    This list is expected to have errors if and only if the electrical
+  //    component is in an error state.
+  //
+  // !!! note
   //     This list is expected to be populated only when the component is in an
   //     error state.
   //     No duplicate error codes allowed.

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

@@ -191,6 +191,11 @@ message SensorState {
   // !!! note
   //    The list will contain unique members. No state will exist twice in
   //    this list.
+  //
+  // !!! note
+  //    If the state is `SENSOR_STATE_CODE_ERROR`, the sensor is in an error
+  //    state. In such cases, the `errors` field will be populated with the
+  //    list of errors.
   repeated SensorStateCode states = 2;
 
   // List of warnings for the microgrid sensor.