@@ -21,22 +21,27 @@ import "google/protobuf/timestamp.proto";
2121
2222import "frequenz/api/common/components.proto" ;
2323
24- // Service providing operations related to dispatching microgrid components.
25- service DispatchService {
24+ // The MicrogridDispatchService serves to automate the process of energy dispatches for various microgrids.
25+ // In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power
26+ // or energy between different components within a microgrid or between a microgrid and the main grid.
27+ // This could be for the purpose of supply (sending energy to the grid, or to components within the microgrid),
28+ // or demand (drawing energy from the grid or from other components like batteries and solar arrays).
29+ // The service allows for both one-off dispatches, and recurring dispatches.
30+ service MicrogridDispatchService {
2631 // Returns a list of all dispatches
27- rpc ListDispatches (DispatchListRequest ) returns (DispatchList );
32+ rpc ListMicrogridDispatches (DispatchListRequest ) returns (DispatchList );
2833
2934 // Create a new dispatch
30- rpc CreateDispatch (DispatchCreateRequest ) returns (google .protobuf .Empty );
35+ rpc CreateMicrogridDispatch (DispatchCreateRequest ) returns (google .protobuf .Empty );
3136
3237 // Update a dispatch
33- rpc UpdateDispatch (DispatchUpdateRequest ) returns (google .protobuf .Empty );
38+ rpc UpdateMicrogridDispatch (DispatchUpdateRequest ) returns (google .protobuf .Empty );
3439
3540 // Get a single dispatch
36- rpc GetDispatch (DispatchGetRequest ) returns (Dispatch );
41+ rpc GetMicrogridDispatch (DispatchGetRequest ) returns (Dispatch );
3742
3843 // Delete a given dispatch
39- rpc DeleteDispatch (DispatchDeleteRequest ) returns (google .protobuf .Empty );
44+ rpc DeleteMicrogridDispatch (DispatchDeleteRequest ) returns (google .protobuf .Empty );
4045}
4146
4247// Message representing one dispatch
0 commit comments