Skip to content

Commit 72ff0ea

Browse files
Rename v1 package to v1alpha7
This commit makes the following changes: - Renames the `v1` package to `v1alpha7` in the proto files. - Renames the `v1` directory to `v1alpha7` in the proto files. - Renames the `v1` directory to `v1alpha7` in the `py` directory. - Rename the test file `test_common.py` to `test_common_v1alpha7.py`. Signed-off-by: Tiyash Basu <[email protected]>
1 parent 6759eda commit 72ff0ea

File tree

34 files changed

+189
-116
lines changed

34 files changed

+189
-116
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@
7676

7777
- The type of the field `metrics.MetricSample.connection` has been changed from `string` to `metrics.MetricConnection`. The latter is a newly added message that provides a better categorization of the connection type.
7878

79+
- The `v1` package has been renamed to `v1alpha7`.
80+
7981
## New Features
8082

8183
Added many new messages and enum values:

proto/frequenz/api/common/v1/grid/delivery_area.proto renamed to proto/frequenz/api/common/v1alpha7/grid/delivery_area.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
syntax = "proto3";
99

10-
package frequenz.api.common.v1.grid;
10+
package frequenz.api.common.v1alpha7.grid;
1111

1212
// CodeType specifies the type of identification code used for uniquely
1313
// identifying various entities such as delivery areas, market participants, and

proto/frequenz/api/common/v1/grid/delivery_duration.proto renamed to proto/frequenz/api/common/v1alpha7/grid/delivery_duration.proto

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Frequenz definitions of the time increment used for electricity
1+
// Frequenz definitions of the time increment used for electricity
22
// deliveries and trading.
33
//
44
// Copyright 2023 Frequenz Energy-as-a-Service GmbH
@@ -8,49 +8,49 @@
88

99
syntax = "proto3";
1010

11-
package frequenz.api.common.v1.grid;
11+
package frequenz.api.common.v1alpha7.grid;
1212

1313
import "google/protobuf/timestamp.proto";
1414

15-
// DeliveryDuration represents the time increment, in minutes,
15+
// DeliveryDuration represents the time increment, in minutes,
1616
// used for electricity deliveries and trading. These durations
1717
// serve as the basis for defining the delivery period in contracts,
18-
// and they dictate how energy is scheduled and delivered to meet
18+
// and they dictate how energy is scheduled and delivered to meet
1919
// contractual obligations.
2020
//
2121
// !!! note "Compatibility Constraints"
22-
// Not all delivery durations are universally
22+
// Not all delivery durations are universally
2323
// compatible with all delivery areas or markets.
2424
//
2525
enum DeliveryDuration {
2626
// Default value, indicates that the duration is unspecified.
27-
DELIVERY_DURATION_UNSPECIFIED = 0;
28-
27+
DELIVERY_DURATION_UNSPECIFIED = 0;
28+
2929
// 5-minute duration
30-
DELIVERY_DURATION_5 = 1;
30+
DELIVERY_DURATION_5 = 1;
3131

3232
// 15-minute contract duration.
33-
DELIVERY_DURATION_15 = 2;
34-
33+
DELIVERY_DURATION_15 = 2;
34+
3535
// 30-minute contract duration.
36-
DELIVERY_DURATION_30 = 3;
37-
36+
DELIVERY_DURATION_30 = 3;
37+
3838
// 1-hour contract duration.
39-
DELIVERY_DURATION_60 = 4;
39+
DELIVERY_DURATION_60 = 4;
4040
}
4141

42-
// DeliveryPeriod represents the time period during which the contract
42+
// DeliveryPeriod represents the time period during which the contract
4343
// is delivered. It is defined by a start timestamp and a duration.
4444
message DeliveryPeriod {
4545
// Start UTC timestamp represents the beginning of the delivery period.
4646
// This timestamp is inclusive, meaning that the delivery period starts
4747
// from this point in time.
48-
//
48+
//
4949
// !!! note
5050
// Delivery period start time constraints:
51-
// - 5-minute durations must start at times that are multiples of
51+
// - 5-minute durations must start at times that are multiples of
5252
// 5 minutes past the hour.
53-
// - 15-minute durations must start at :00, :15, :30, or
53+
// - 15-minute durations must start at :00, :15, :30, or
5454
// :45 past the hour.
5555
// - 30-minute durations must start at :00 or :30 past the hour.
5656
// - 60-minute durations must start at :00 past the hour.

proto/frequenz/api/common/v1/market/energy.proto renamed to proto/frequenz/api/common/v1alpha7/market/energy.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
syntax = "proto3";
99

10-
package frequenz.api.common.v1.market;
10+
package frequenz.api.common.v1alpha7.market;
1111

12-
import "frequenz/api/common/v1/type/decimal.proto";
12+
import "frequenz/api/common/v1alpha7/type/decimal.proto";
1313

1414
// Represents a single unit of electricity.
1515
//
@@ -20,5 +20,5 @@ import "frequenz/api/common/v1/type/decimal.proto";
2020
// production or consumption.
2121
message Energy {
2222
// Energy unit in Megawatthours (MWh).
23-
frequenz.api.common.v1.type.Decimal mwh = 1;
23+
frequenz.api.common.v1alpha7.type.Decimal mwh = 1;
2424
}

proto/frequenz/api/common/v1/market/power.proto renamed to proto/frequenz/api/common/v1alpha7/market/power.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
syntax = "proto3";
99

10-
package frequenz.api.common.v1.market;
10+
package frequenz.api.common.v1alpha7.market;
1111

12-
import "frequenz/api/common/v1/type/decimal.proto";
12+
import "frequenz/api/common/v1alpha7/type/decimal.proto";
1313

1414
// Represents a single unit of power.
1515
//
@@ -26,5 +26,5 @@ import "frequenz/api/common/v1/type/decimal.proto";
2626
// market applications.
2727
message Power {
2828
// Power amount in Megawatts (MW).
29-
frequenz.api.common.v1.type.Decimal mw = 1;
29+
frequenz.api.common.v1alpha7.type.Decimal mw = 1;
3030
}

proto/frequenz/api/common/v1/market/price.proto renamed to proto/frequenz/api/common/v1alpha7/market/price.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
syntax = "proto3";
99

10-
package frequenz.api.common.v1.market;
10+
package frequenz.api.common.v1alpha7.market;
1111

12-
import "frequenz/api/common/v1/type/decimal.proto";
12+
import "frequenz/api/common/v1alpha7/type/decimal.proto";
1313

1414
// Represents a monetary price for electricity trading, including
1515
// the amount and currency. The currency used should align with the
@@ -46,7 +46,7 @@ message Price {
4646
}
4747

4848
// The amount of the price.
49-
frequenz.api.common.v1.type.Decimal amount = 1;
49+
frequenz.api.common.v1alpha7.type.Decimal amount = 1;
5050

5151
// The currency in which the price is denominated.
5252
Currency currency = 2;

proto/frequenz/api/common/v1/metrics/bounds.proto renamed to proto/frequenz/api/common/v1alpha7/metrics/bounds.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
syntax = "proto3";
1010

11-
package frequenz.api.common.v1.metrics;
11+
package frequenz.api.common.v1alpha7.metrics;
1212

1313
// A set of lower and upper bounds for any metric.
1414
// The units of the bounds are always the same as the related metric.

proto/frequenz/api/common/v1/metrics/metrics.proto renamed to proto/frequenz/api/common/v1alpha7/metrics/metrics.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
syntax = "proto3";
1010

11-
package frequenz.api.common.v1.metrics;
11+
package frequenz.api.common.v1alpha7.metrics;
1212

13-
import "frequenz/api/common/v1/metrics/bounds.proto";
13+
import "frequenz/api/common/v1alpha7/metrics/bounds.proto";
1414

1515
import "google/protobuf/timestamp.proto";
1616

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
syntax = "proto3";
1212

13-
package frequenz.api.common.v1.microgrid.communication_components;
13+
package frequenz.api.common.v1alpha7.microgrid.communication_components;
1414

1515
import "google/protobuf/timestamp.proto";
1616

proto/frequenz/api/common/v1/microgrid/electrical_components/battery.proto renamed to proto/frequenz/api/common/v1alpha7/microgrid/electrical_components/battery.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
syntax = "proto3";
1010

11-
package frequenz.api.common.v1.microgrid.electrical_components;
11+
package frequenz.api.common.v1alpha7.microgrid.electrical_components;
1212

1313
// Enumerated battery types.
1414
enum BatteryType {

0 commit comments

Comments
 (0)