Skip to content

ElectricalComponentConnection fields are named inconsistently #395

@tiyash-basu-frequenz

Description

@tiyash-basu-frequenz

What's needed?

Here is the definition of ElectricalComponentConnection message:

message ElectricalComponentConnection {
// Unique identifier of the component where the connection originates. This is
// aligned with the direction of current flow away from the grid connection
// point, or in case of islands, away from the islanding point.
uint64 source_component_id = 1;
// Unique ID of the component where the connection terminates. This is the
// component towards which the current flows.
uint64 destination_component_id = 2;
// The operational lifetime of the connection.
frequenz.api.common.v1alpha7.microgrid.Lifetime operational_lifetime = 3;
}

The fields source_component_id and destination_component_id are not consistent with the other places in this file where we use the term electrical_component instead.

Proposed solution

Rename:

  • source_component_id - source_electrical_component_id
  • destination_component_id - destination_electrical_component_id

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

Metadata

Metadata

Labels

part:❓We need to figure out which part is affectedpriority:❓We need to figure out how soon this should be addressedtype:enhancementNew feature or enhancement visitble to users

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions