Skip to content

Commit 0d25ca8

Browse files
Protolint fixes
Signed-off-by: tomni <thomas.nicolai@frequenz.com>
1 parent 17e09c3 commit 0d25ca8

1 file changed

Lines changed: 24 additions & 23 deletions

File tree

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

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
// protolint:disable MAX_LINE_LENGTH
2-
31
// Frequenz Assets API
42
//
53
// Frequenz gRPC API to retrieval platform assets information.
@@ -14,25 +12,26 @@ syntax = "proto3";
1412

1513
package frequenz.api.assets.v1;
1614

15+
// protolint:disable:next MAX_LINE_LENGTH
1716
import "frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto";
1817
import "frequenz/api/common/v1alpha8/microgrid/microgrid.proto";
1918

20-
2119
// Service providing access to manage and retrieve information
2220
// related to gridpools and microgrids, and other platform assets.
2321
service PlatformAssets {
2422
// Returns details of a specific microgrid.
2523
rpc GetMicrogrid(GetMicrogridRequest) returns (GetMicrogridResponse);
2624

2725
// Returns list of a electrical components for a specific microgrid.
28-
rpc ListMicrogridElectricalComponents(ListMicrogridElectricalComponentsRequest)
26+
rpc ListMicrogridElectricalComponents(
27+
ListMicrogridElectricalComponentsRequest)
2928
returns (ListMicrogridElectricalComponentsResponse);
3029

3130
// Returns a list of the connections between electrical components for a
3231
// specific microgrid.
3332
rpc ListMicrogridElectricalComponentConnections(
34-
ListMicrogridElectricalComponentConnectionsRequest
35-
) returns (ListMicrogridElectricalComponentConnectionsResponse);
33+
ListMicrogridElectricalComponentConnectionsRequest)
34+
returns (ListMicrogridElectricalComponentConnectionsResponse);
3635
}
3736

3837
// GetMicrogridRequest is the input parameter for fetching details
@@ -59,7 +58,8 @@ message ListMicrogridElectricalComponentsRequest {
5958
repeated uint64 component_ids = 2;
6059

6160
// Return components that have the specified categories only.
62-
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentCategory categories = 3;
61+
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.
62+
ElectricalComponentCategory categories = 3;
6363
}
6464

6565
// A message containing a list of electrical components.
@@ -68,29 +68,29 @@ message ListMicrogridElectricalComponentsResponse {
6868
uint64 microgrid_id = 1;
6969

7070
// List of electrical components matching the filter criteria.
71-
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponent components = 2;
71+
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.
72+
ElectricalComponent components = 2;
7273
}
7374

7475
// ListMicrogridElectricalComponentConnectionsRequest is used for listing
75-
// the electrical connections between components in a microgrid. Connections define
76-
// a directed graph of electrical energy flow.
76+
// the electrical connections between components in a microgrid. Connections
77+
// define a directed graph of electrical energy flow.
7778
//
7879
// !!! note "Component Graph"
79-
// A component graph in the context of a microgrid refers to a directed graph
80-
// where the nodes represent electrical components (like generators, batteries,
81-
// or loads) and the edges represent electrical connections between them.
82-
// The edges are directional, pointing away from the grid-connection point
83-
// (or the root point for island microgrids).
80+
// A component graph in the context of a microgrid refers to a directed
81+
// graph where the nodes represent electrical components (like
82+
// generators, batteries, or loads) and the edges represent electrical
83+
// connections between them. The edges are directional, pointing away
84+
// from the grid-connection point (or the root point for island microgrids).
8485
// This means that for each edge, the source component is towards the grid
8586
// connection point, and the destination component is pointing towards
86-
// an underlying component.
87-
// This graph provides a structured view of how electrical energy flows within
88-
// the microgrid.
87+
// an underlying component. This graph provides a structured view of how
88+
// electrical energy flows within the microgrid.
8989
//
9090
// !!! note "Filtering"
9191
// Filtering can be done based on the source_component_id or
92-
// destination_component_id. If these fields are left empty, connections with
93-
// any source or destination will be returned.
92+
// destination_component_id. If these fields are left empty, connections
93+
// with any source or destination will be returned.
9494
//
9595
message ListMicrogridElectricalComponentConnectionsRequest {
9696
// Mandatory field. The ID of the microgrid
@@ -106,13 +106,14 @@ message ListMicrogridElectricalComponentConnectionsRequest {
106106
repeated uint64 destination_component_ids = 3;
107107
}
108108

109-
// ListMicrogridElectricalComponentConnectionsResponse holds the list of electrical
110-
// connections that match the filter criteria specified in the
109+
// ListMicrogridElectricalComponentConnectionsResponse holds the list of
110+
// electrical connections that match the filter criteria specified in the
111111
// ListMicrogridElectricalComponentConnectionsRequest.
112112
message ListMicrogridElectricalComponentConnectionsResponse {
113113
// The ID of the microgrid for which connections are returned.
114114
uint64 microgrid_id = 1;
115115

116116
// Contains the list of connections that match the filtering criteria.
117-
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.ElectricalComponentConnection connections =2;
117+
repeated frequenz.api.common.v1alpha8.microgrid.electrical_components.
118+
ElectricalComponentConnection connections =2;
118119
}

0 commit comments

Comments
 (0)