Frequenz Common API Release Notes
Summary
This release includes renaming the `EVChargerType` enum to `EvChargerType` and
the addition of the `MetricAggregation` message.
Upgrading
* The submodule URL was changed to use HTTPS instead of SSH (to avoid problems trying to unlock SSH keys to do updates, etc.).
Make sure you sync your submodules to the new URL:
console
$ git submodule sync
Synchronizing submodule url for 'submodules/api-common-protos'
* [`EVChargerType` enum refactored](https://github.com/frequenz-floss/frequenz-api-common/pull/21)
The enum with the oder variants was compiled into the following rust enum
(by prost):
rust
pub enum EvChargerType {
/// Default type.
EvchargerTypeUnspecified = 0,
/// The EV charging station supports AC charging only.
EvchargerTypeAc = 1,
/// The EV charging station supports DC charging only.
EvchargerTypeDc = 2,
/// The EV charging station supports both AC and DC.
EvchargerTypeHybrid = 3,
}
Here the enum variants were unnecessarily prefixed with `EvchargerType`.
This lead to accessing the enum variants in a very verbose manner, e.g.,
`EvChargerType::EvchargerTypeHybrid`.
The changed version of the enum in this commit results in the following
rust enum:
rust
pub enum EvChargerType {
/// Default type.
Unspecified = 0,
/// The EV charging station supports AC charging only.
Ac = 1,
/// The EV charging station supports DC charging only.
Dc = 2,
/// The EV charging station supports both AC and DC.
Hybrid = 3,
}
Here the unnecessary prefix `EvchargerType` is absent. This reduces the
verbosity while accessing the enum variants, making the resulting rust code
more readable, e.g., as `EvChargerType::Hybrid`.
This change also leads to renaming the enum from `EVChargerType` to
`EvChargerType`, to satisfy protolint requirements.
New Features
* [Added `MetricAggregation` message](https://github.com/frequenz-floss/frequenz-api-common/pull/22)
The message `MetricAggregation` has been [copied from frequenz-api-microgrid](https://github.com/frequenz-floss/frequenz-api-microgrid/blob/2b316db3d34565fa04445be62700176d07756750/proto/frequenz/api/microgrid/common.proto#L15-L99)
into this repository, so that it can be used by other APIs as well.
Bug Fixes
None
What's Changed
* Use HTTPS URL for the submodule by leandro-lucarella-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/17
* Bump actions/labeler from 4.0.3 to 4.0.4 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/18
* Bump frequenz-repo-config[api] from 0.1.0 to 0.2.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/19
* Bump actions/labeler from 4.0.4 to 4.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/20
* Refactor `EVChargerType` enum variants by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/21
* Add `MetricAggregation` message by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/22
* Prepare for release v0.3.0 by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/23
New Contributors
* tiyash-basu-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-api-common/pull/21
**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-common/compare/v0.2.0...v0.3.0