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

Remove Metadata from GetMicrogridMetadata and GetMicrogridMetadataResponse #260

Open
llucax opened this issue Sep 16, 2024 · 4 comments
Open
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 16, 2024

What's needed?

It seems the "metadata" word was removed from all other parts, like the microgrid message type, so it looks like including Metadata in these names is inconsistent.

Proposed solution

Rename:

  • GetMicrogridMetadata -> GetMicrogrid
  • GetMicrogridMetadataResponse -> GetMicrogridResponse

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

@llucax llucax added part:❓ We need to figure out which part is affected priority:❓ We need to figure out how soon this should be addressed type:enhancement New feature or enhancement visitble to users part:protobuf Affects the protocol buffer definition files and removed part:❓ We need to figure out which part is affected priority:❓ We need to figure out how soon this should be addressed labels Sep 16, 2024
@llucax llucax added this to the v0.18.0 milestone Sep 16, 2024
@tiyash-basu-frequenz
Copy link
Contributor

tiyash-basu-frequenz commented Sep 16, 2024

Maybe

GetMicrogridMetadata => GetMicrogridInfo?

@llucax
Copy link
Contributor Author

llucax commented Sep 17, 2024

For me this is a general design question, and for me the number 1 priority is to have consistency, for me it would be weird that GerMicrogridInfo has a Microgrid message in the response instead of a MicrogridInfo message, so if we name this GetMicrogridInfo, I would then rename Microgrid to MicrogridInfo. And that goes for all messages (Component -> ComponentInfo, Battery -> BatteryInfo, etc.).

At this stage the least breaking change would be to just use GerMicrogrid. If we are keeping the inconsistency of having a method GetMicrogridInfo that returns a Microgrid, then I don't see a point in renaming GerMicrogridMetadata in the first place.

But maybe I'm too of a purist :)

@tiyash-basu-frequenz
Copy link
Contributor

IMO we should name Microgrid to MicrogridInfo everywhere.

@llucax
Copy link
Contributor Author

llucax commented Sep 18, 2024

Sounds good to me! What about components?

@llucax llucax added the scope:breaking-change Breaking change, users will need to update their code label 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

2 participants