Re-design dispatch filter message

Removes a few fields that shouldn't be filterable, and introduces the
DispatchListRequest message, where the microgrid_id is mandatory

Fixes #27

Signed-off-by: Stefan Brus <[email protected]>

Author: stefan-brus-frequenz

RELEASE_NOTES.md

@@ -3,3 +3,5 @@
 - The field `create_time` has been removed from update requests.
 - An `update_time` field has been added to the Dispatch object.
 - The `type` field has been removed from update requests, to prevent it from being modified after creation.
+- `DispatchFilter` has been replaced by `DispatchListRequest` as a parameter for `ListDispatches`.
+  - The filter has additionally been re-designed, with fields that lack use cases being removed.

proto/frequenz/api/dispatch/dispatch.proto

@@ -21,7 +21,7 @@ import "frequenz/api/common/components.proto";
 
 service DispatchService {
   // Returns a list of all dispatches
-  rpc ListDispatches(DispatchFilter) returns (DispatchList) {
+  rpc ListDispatches(DispatchListRequest) returns (DispatchList) {
     option (google.api.http) = {
       get: "/v1/dispatches"
     };
@@ -116,31 +116,26 @@ message DispatchComponentIDs {
   repeated uint64 component_ids = 1;
 }
 
-// Parameters for filtering the dispatch list
-message DispatchFilter {
-  // Filter by dispatch ID
-  repeated uint64 ids = 1;
-
-  // Filter by microgrid ID
-  repeated uint64 microgrid_ids = 2;
+// Message for listing dispatches for a given microgrid, and an optional filter
+message DispatchListRequest {
+  // The microgrid ID
+  uint64 microgrid_id = 1;
 
-  // Filter by dispatch type
-  repeated string types = 3;
+  // Additional filter parameters
+  DispatchFilter filter = 2;
+}
 
+// Parameters for filtering the dispatch list
+message DispatchFilter {
   // Filter by component ID or category
-  repeated DispatchComponentSelector selectors = 4;
+  repeated DispatchComponentSelector selectors = 1;
 
   // Filter by time interval
-  TimeIntervalFilter time_interval = 5;
-
-  // Filter by "active" status
-  optional bool is_active = 6;
-
-  // Filter by "dry run" status
-  optional bool is_dry_run = 7;
+  // If no interval is provided, all dispatches starting from the
+  // current timestamp will be included.
+  TimeIntervalFilter time_interval = 2;
 }
 
-
 // A list of dispatches
 message DispatchList {
   // The dispatches