The ListConnections RPC has a request message that talks about start and end, which is a bit confusing, as it sounds like it might be referring to ranges of IDs, which is very weird.
The ComponentConnection message in api-common was renamed to use source and destination instead of start and end, so the microgrid API should probably adopt those terms too.
Proposed solution
// Request parameters for the RPC `ListConnections`.
// Contains filtering parameters for listing connections.
message ListConnectionsRequest {
// Only return connections that originate from the specified component ID(s):
// if empty, connections with any `source_component_id` will be returned
repeated uint64 source_component_ids = 1;
// Only return connections that terminate at the specified component ID(s):
// if empty, connections with any `destination_component_id` will be returned
repeated uint64 destination_component_ids = 2;
}
What's needed?
The
ListConnectionsRPC has a request message that talks aboutstartandend, which is a bit confusing, as it sounds like it might be referring to ranges of IDs, which is very weird.https://github.com/frequenz-floss/frequenz-api-microgrid/blob/8f4e4f897d0082140c8eb8da9dd70c8efdb1aa92/proto/frequenz/api/microgrid/v1/microgrid.proto#L360-L370
The
ComponentConnectionmessage inapi-commonwas renamed to usesourceanddestinationinstead ofstartandend, so the microgrid API should probably adopt those terms too.Proposed solution
Use cases
No response
Alternatives and workarounds
No response
Additional context
No response