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.

Sign up for GitHub

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

Jump to bottom

Removing all deprecated code #44

Merged
merged 1 commit into from
Apr 22, 2023
Merged

Removing all deprecated code #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,18 @@

The RPC `SetBounds` has been deprecated.

* [Removed deprecated code](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/44)
The following deprecated code has been removed:
* The `COMPONENT_CATEGORY_LOAD` variant from the `ComponentCategory` enum.
* The `COMPONENT_CATEGORY_JUNCTION` variant from the `ComponentCategory` enum.
* The RPCs `Charge` and `Discharge`, in favour of RPC `SetPowerActive`.
* The RPC `SetBounds`, in favour of RPCs `AddExclusiveBounds` and
`AddInclusiveBounds`.

This removal also includes code that has been deprecated after the last major
release. The reason to remove these deprecations now is to have a leaner API
earlier, since we are already on the way for a major release now.

## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
57 changes: 0 additions & 57 deletions proto/frequenz/api/microgrid/microgrid.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,6 @@ service Microgrid {
};
}

// Sets the bounds for a given bounded metric of a given component.
rpc SetBounds(stream SetBoundsParam) returns (google.protobuf.Empty) {
option deprecated = true;
}

// Adds exclusion bounds for a given metric of a given component, and returns
// the UTC timestamp until which the given exclusion bounds will stay in
// effect.
Expand Down Expand Up @@ -182,50 +177,6 @@ service Microgrid {
// ==== vales here are allowed and will be accepted
rpc AddInclusionBounds(SetBoundsParam) returns (google.protobuf.Timestamp);

// Sets the charge power of a component with a given ID, provided the
// component supports it.
//
// Note that the target component may have a resolution of more than 1 W.
// E.g., an inverter may have a resolution of 88 W.
// In such cases, the charge power will be floored to the nearest multiple of
// the resolution.
//
// Performs the following sequence actions for the following component
// categories:
//
// * Inverter: Sends the charge command to the inverter, making it consume AC
// power.
//
// Deprecated: use `SetPowerActive` instead.
rpc Charge(PowerLevelParam) returns (google.protobuf.Empty) {
option deprecated = true;
option (google.api.http) = {
get : "/v1/components/{component_id}/charge/{power_w}"
};
}

// Sets the discharge power of a component with a given ID, provided the
// component supports it.
//
// Note that the target component may have a resolution of more than 1 W.
// E.g., an inverter may have a resolution of 88 W.
// In such cases, the discharge power will be floored to the nearest multiple
// of the resolution.
//
// Performs the following sequence actions for the following component
// categories:
//
// * Inverter: Sends the discharge command to the inverter, making it deliver
// AC power.
//
// Deprecated: use `SetPowerActive` instead.
rpc Discharge(PowerLevelParam) returns (google.protobuf.Empty) {
option deprecated = true;
option (google.api.http) = {
get : "/v1/components/{component_id}/discharge/{power_w}"
};
}

// Sets the power output of a component with a given ID, provided the
// component supports it.
//
Expand Down Expand Up @@ -401,14 +352,6 @@ enum ComponentCategory {

// A heat and power combustion plant (CHP stands for combined heat and power).
COMPONENT_CATEGORY_CHP = 10;

// An electrical load in the microgrid, consuming AC electricity.
// Note that this will be removed in the next release.
COMPONENT_CATEGORY_LOAD = 14;

// A node in the circuit, where all connections meet.
// Note that this will be removed in the next release.
COMPONENT_CATEGORY_JUNCTION = 15;
}

// Parameters for filtering the components.
Expand Down