Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix terminology in the ListConnections RPC #262

Open
llucax opened this issue Sep 19, 2024 · 0 comments
Open

Fix terminology in the ListConnections RPC #262

llucax opened this issue Sep 19, 2024 · 0 comments
Labels
part:protobuf Affects the protocol buffer definition files scope:breaking-change Breaking change, users will need to update their code type:enhancement New feature or enhancement visitble to users
Milestone

Comments

@llucax
Copy link
Contributor

llucax commented Sep 19, 2024

What's needed?

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.

// Request parameters for the RPC `ListConnections`.
// Contains filtering parameters for listing connections.
message ListConnectionsRequest {
// Only return connections that start from the specified component ID(s):
// if empty, connections with any `start` will be returned
repeated uint64 starts = 1;
// Only return connections that end at the specified component ID(s):
// if empty, connections with any `end` will be returned
repeated uint64 ends = 2;
}

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;
}

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

@llucax llucax added type:enhancement New feature or enhancement visitble to users part:protobuf Affects the protocol buffer definition files scope:breaking-change Breaking change, users will need to update their code labels Sep 19, 2024
@llucax llucax added this to the v0.18.0 milestone Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:protobuf Affects the protocol buffer definition files scope:breaking-change Breaking change, users will need to update their code type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

No branches or pull requests

1 participant