diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 886490d..322cc7a 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -2,15 +2,19 @@ ## Summary -Documentation improvement -Rename service +This release adds `ListMicrogrids` and `GetGridpool` to +`frequenz.api.platformassets.v1alpha1`. ## Upgrading -- Improved ListMicrogridElectricalComponentConnectionsRequest header doc -- Rename service -- Introduced new version +- `frequenz.api.platformassets.v1alpha1.PlatformAssetsService` now includes + `ListMicrogrids`. +- `frequenz.api.platformassets.v1alpha1` includes the `GetGridpool` + request/response messages and RPC. +- `frequenz.api.platformassets.v1alpha1` remains a separate versioned package + with the renamed `PlatformAssetsService`. ## New Features -n/a +- Add the `ListMicrogrids` RPC to the `PlatformAssetsService` service. +- Add the `GetGridpool` RPC to the `PlatformAssetsService` service. diff --git a/proto/frequenz/api/platformassets/v1alpha1/platformassets.proto b/proto/frequenz/api/platformassets/v1alpha1/platformassets.proto index dfaec4d..9e53c8a 100644 --- a/proto/frequenz/api/platformassets/v1alpha1/platformassets.proto +++ b/proto/frequenz/api/platformassets/v1alpha1/platformassets.proto @@ -12,6 +12,8 @@ syntax = "proto3"; package frequenz.api.platformassets.v1alpha1; +// protolint:disable:next MAX_LINE_LENGTH +import "frequenz/api/common/v1alpha8/gridpool/gridpool.proto"; // protolint:disable:next MAX_LINE_LENGTH import "frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto"; import "frequenz/api/common/v1alpha8/microgrid/microgrid.proto"; @@ -36,6 +38,12 @@ import "frequenz/api/common/v1alpha8/microgrid/microgrid.proto"; // over TLS (HTTPS). // service PlatformAssetsService { + // Returns metadata for all microgrids visible to the caller. + rpc ListMicrogrids(ListMicrogridsRequest) returns (ListMicrogridsResponse); + + // Returns metadata for a specific gridpool. + rpc GetGridpool(GetGridpoolRequest) returns (GetGridpoolResponse); + // Returns metadata for a specific microgrid. rpc GetMicrogrid(GetMicrogridRequest) returns (GetMicrogridResponse); @@ -51,6 +59,30 @@ service PlatformAssetsService { returns (ListMicrogridElectricalComponentConnectionsResponse); } +// Request message for listing all visible microgrids. +message ListMicrogridsRequest { +} + +// Response message containing all visible microgrids. +message ListMicrogridsResponse { + // Microgrids visible to the caller. + repeated frequenz.api.common.v1alpha8.microgrid.Microgrid microgrids = 1; +} + +// Request message for retrieving metadata for a specific gridpool. +message GetGridpoolRequest { + // The unique identifier of the gridpool for which to fetch details. + uint64 gridpool_id = 1; +} + +// Response message containing metadata for a specific gridpool. +message GetGridpoolResponse { + // Details of the requested gridpool. + frequenz.api.common.v1alpha8.gridpool.Gridpool gridpool = 1; + // Microgrids belonging to the requested gridpool. + repeated frequenz.api.common.v1alpha8.microgrid.Microgrid microgrids = 2; +} + // Filters for selecting electrical component connections in a microgrid. // // A connection must match all specified filter fields to be included in the diff --git a/submodules/frequenz-api-common b/submodules/frequenz-api-common index 300bcb4..b3ca6ca 160000 --- a/submodules/frequenz-api-common +++ b/submodules/frequenz-api-common @@ -1 +1 @@ -Subproject commit 300bcb4296d679faa3b2aec33e7ea3d461d90beb +Subproject commit b3ca6ca43e5c64ccdab84f08828f76bce13706fb