Skip to content

Commit bee3053

Browse files
authored
Merge pull request #37 from sandovalrr/feat/use-v1-alpha8
feat(v1alpha8): Update proto imports to v1alpha8 for microgrid components in assets.proto
2 parents facd2dc + 4c61241 commit bee3053

File tree

4 files changed

+30
-32
lines changed

4 files changed

+30
-32
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,11 @@
22

33
## Summary
44

5-
Adjusted the RPC names to align with the new naming convention, and updated the `frequenz-api-common` dependency.
6-
75

86
## Upgrading
97

10-
- Update the `frequenz-api-common` dependency
8+
- Update the `frequenz-api-common` dependency
119

1210
## New Features
1311

14-
- Renamed `ListMicrogridComponents` to `ListMicrogridElectricalComponents` and `ListMicrogridComponentConnections` to `ListMicrogridElectricalComponentConnections`.
1512

proto/frequenz/api/assets/v1/assets.proto

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ syntax = "proto3";
1414

1515
package frequenz.api.assets.v1;
1616

17-
import "frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto";
18-
import "frequenz/api/common/v1/microgrid/microgrid.proto";
17+
import "frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto";
18+
import "frequenz/api/common/v1alpha8/microgrid/microgrid.proto";
19+
1920

2021
// Service providing access to manage and retrieve information
2122
// related to gridpools and microgrids, and other platform assets.
@@ -45,7 +46,7 @@ message GetMicrogridRequest {
4546
// given a specific microgrid.
4647
message GetMicrogridResponse {
4748
// Details of the requested microgrid.
48-
frequenz.api.common.v1.microgrid.Microgrid microgrid = 1;
49+
frequenz.api.common.v1alpha8.microgrid.Microgrid microgrid = 1;
4950
}
5051

5152
// Request parameters for the RPC `ListMicrogridElectricalComponents`.
@@ -58,7 +59,7 @@ message ListMicrogridElectricalComponentsRequest {
5859
repeated uint64 component_ids = 2;
5960

6061
// Return components that have the specified categories only.
61-
repeated frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponentCategory categories = 3;
62+
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentCategory categories = 3;
6263
}
6364

6465
// A message containing a list of electrical components.
@@ -67,7 +68,7 @@ message ListMicrogridElectricalComponentsResponse {
6768
uint64 microgrid_id = 1;
6869

6970
// List of electrical components matching the filter criteria.
70-
repeated frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponent components = 2;
71+
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponent components = 2;
7172
}
7273

7374
// ListMicrogridElectricalComponentConnectionsRequest is used for filtering and listing
@@ -115,5 +116,5 @@ message ListMicrogridElectricalComponentConnectionsResponse {
115116
uint64 microgrid_id = 1;
116117

117118
// Contains the list of connections that match the filtering criteria.
118-
repeated frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponentConnection connections =2;
119+
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentConnection connections =2;
119120
}

pyproject.toml

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33

44
[build-system]
55
requires = [
6-
"setuptools == 75.8.0",
6+
"setuptools == 80.9.0",
77
"setuptools_scm[toml] == 8.3.1",
8-
"frequenz-repo-config[api] == 0.13.3",
8+
"frequenz-repo-config[api] == 0.13.5",
99
# We need to pin the protobuf, grpcio and grpcio-tools dependencies to make
1010
# sure the code is generated using the minimum supported versions, as older
1111
# versions can't work with code that was generated with newer versions.
1212
# https://protobuf.dev/support/cross-version-runtime-guarantee/#backwards
13-
"protobuf == 5.29.3",
14-
"grpcio-tools == 1.70.0",
15-
"grpcio == 1.70.0",
13+
"protobuf == 6.31.1",
14+
"grpcio-tools == 1.73.1",
15+
"grpcio == 1.73.1",
1616
]
1717
build-backend = "setuptools.build_meta"
1818

@@ -45,15 +45,15 @@ classifiers = [
4545
]
4646
requires-python = ">= 3.11, < 4"
4747
dependencies = [
48-
"frequenz-api-common @ git+https://github.com/frequenz-floss/frequenz-api-common.git@0e45c6d7fe92b708f1e7ca7a6f13e4513bfe7cf4",
48+
"frequenz-api-common >= 0.8.0, < 0.9",
4949
# We can't widen beyond the current value unless we bump the minimum
5050
# requirements too because of protobuf cross-version runtime guarantees:
5151
# https://protobuf.dev/support/cross-version-runtime-guarantee/#major
5252
"protobuf >= 6.31.1, < 8", # Do not widen beyond 8!
5353
# We couldn't find any document with a spec about the cross-version runtime
5454
# guarantee for grpcio, so unless we find one in the future, we'll assume
5555
# major version jumps are not compatible
56-
"grpcio >= 1.72.1, < 2", # Do not widen beyond 2!
56+
"grpcio >= 1.73.1, < 2", # Do not widen beyond 2!
5757
]
5858
dynamic = ["version"]
5959

@@ -63,42 +63,42 @@ email = "floss@frequenz.com"
6363

6464
[project.optional-dependencies]
6565
dev-flake8 = [
66-
"flake8 == 7.2.0",
66+
"flake8 == 7.3.0",
6767
"flake8-docstrings == 1.7.0",
68-
"flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
68+
"flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
6969
"pydoclint == 0.6.6",
7070
"pydocstyle == 6.3.0",
7171
]
7272
dev-formatting = ["black == 25.1.0", "isort == 6.0.1"]
7373
dev-mkdocs = [
74-
"Markdown == 3.8",
74+
"Markdown == 3.8.2",
7575
"black == 25.1.0",
7676
"mike == 2.1.3",
7777
"mkdocs-gen-files == 0.5.0",
7878
"mkdocs-literate-nav == 0.6.2",
7979
"mkdocs-macros-plugin == 1.3.7",
80-
"mkdocs-material == 9.6.12",
81-
"mkdocstrings[python] == 0.29.1",
82-
"mkdocstrings-python == 1.16.10",
83-
"frequenz-repo-config[api] == 0.13.3",
80+
"mkdocs-material == 9.6.16",
81+
"mkdocstrings[python] == 0.30.0",
82+
"mkdocstrings-python == 1.16.12",
83+
"frequenz-repo-config[api] == 0.13.5",
8484
]
8585
dev-mypy = [
86-
"mypy == 1.15.0",
87-
"grpc-stubs == 1.53.0.5",
88-
"types-Markdown == 3.8.0.20250415",
86+
"mypy == 1.17.1",
87+
"grpc-stubs == 1.53.0.6",
88+
"types-Markdown == 3.8.0.20250708",
8989
# For checking the noxfile, docs/ script, and tests
9090
"frequenz-api-assets[dev-mkdocs,dev-noxfile,dev-pytest]",
9191
]
92-
dev-noxfile = ["nox == 2024.10.9", "frequenz-repo-config[api] == 0.13.3"]
92+
dev-noxfile = ["nox == 2025.5.1", "frequenz-repo-config[api] == 0.13.5"]
9393
dev-pylint = [
9494
# dev-pytest already defines a dependency to pylint because of the examples
9595
# For checking the noxfile, docs/ script, and tests
9696
"frequenz-api-assets[dev-mkdocs,dev-noxfile,dev-pytest]",
9797
]
9898
dev-pytest = [
99-
"pytest == 8.3.5",
100-
"pylint == 3.3.6", # We need this to check for the examples
101-
"frequenz-repo-config[extra-lint-examples] == 0.13.3",
99+
"pytest == 8.4.1",
100+
"pylint == 3.3.7",
101+
"frequenz-repo-config[extra-lint-examples] == 0.13.5",
102102
]
103103
dev = [
104104
"frequenz-api-assets[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

submodules/frequenz-api-common

Submodule frequenz-api-common updated 88 files

0 commit comments

Comments
 (0)