Introduce FieldMask to update requests (#87)

Fixes #74

Blocked until #78 is merged

Author: stefan-brus-frequenz

RELEASE_NOTES.md

@@ -3,15 +3,18 @@
 ## Summary
 
 - End time has been moved to the recurrence rule object, replaced by `duration` on the base dispatch object.
+- Update requests now use a `FieldMask` to indicate which fields should be updated.
 
 ## Upgrading
 
 - Queries that compare against a time interval filter should check for the end time inside the recurrence rule.
 - `end_time` has been renamed `until` and is mutually exclusive with `count`.
+- Update request handlers should check the field mask for which attributes to update.
 
 ## New Features
 
 - Introduced a new field `duration`.
+- Introduced `FieldMask` to the update request.
 
 ## Bug Fixes
 

proto/frequenz/api/dispatch/v1/dispatch.proto

@@ -41,6 +41,7 @@ syntax = "proto3";
 package frequenz.api.dispatch.v1;
 
 import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
@@ -332,32 +333,71 @@ message DispatchCreateRequest {
 
 // Message to update the dispatch with the given ID, with the given attributes
 message DispatchUpdateRequest {
-  // The dispatch identifier
-  uint64 id = 1;
+  // Message containing the updated dispatch attributes
+  message DispatchUpdate {
+    // Message containing the updated recurrence rule attributes
+    message RecurrenceRuleUpdate {
+      // The frequency specifier of this recurring dispatch
+      optional RecurrenceRule.Frequency freq = 1;
 
-  // The start time
-  // When updating a dispatch, ensure that the starting timestamp is set to
-  // the current time or any future time.
-  // Timestamps earlier than the current time are not allowed.
-  google.protobuf.Timestamp start_time = 2;
+      // How often this dispatch should recur, based on the frequency
+      optional uint32 interval = 2;
 
-  // Duration in seconds
-  optional uint32 duration = 3;
+      // When this dispatch should end.
+      RecurrenceRule.EndCriteria end_criteria = 3;
 
-  // The component selector
-  ComponentSelector selector = 4;
+      // On which minute(s) of the hour does the event occur
+      repeated uint32 byminutes = 4;
 
-  // The "active" status
-  optional bool is_active = 5;
+      // On which hour(s) of the day does the event occur
+      repeated uint32 byhours = 5;
 
-  // The "dry run" status
-  optional bool is_dry_run = 6;
+      // On which day(s) of the week does the event occur
+      repeated RecurrenceRule.Weekday byweekdays = 6;
 
-  // The dispatch payload
-  google.protobuf.Struct payload = 7;
+      // On which day(s) of the month does the event occur
+      repeated uint32 bymonthdays = 7;
 
-  // The recurrence rule
-  RecurrenceRule recurrence = 8;
+      // On which month(s) of the year does the event occur
+      repeated uint32 bymonths = 8;
+    }
+
+    // The type of dispatch
+    optional string type = 1;
+
+    // The start time
+    // When updating a dispatch, ensure that the starting timestamp is set to
+    // the current time or any future time.
+    // Timestamps earlier than the current time are not allowed.
+    google.protobuf.Timestamp start_time = 2;
+
+    // Duration in seconds
+    optional uint32 duration = 3;
+
+    // The component selector
+    ComponentSelector selector = 4;
+
+    // The "active" status
+    optional bool is_active = 5;
+
+    // The "dry run" status
+    optional bool is_dry_run = 6;
+
+    // The dispatch payload
+    google.protobuf.Struct payload = 7;
+
+    // The recurrence rule
+    RecurrenceRuleUpdate recurrence = 8;
+  }
+
+  // The dispatch identifier
+  uint64 id = 1;
+
+  // Field mask specifying which fields should be updated
+  google.protobuf.FieldMask update_mask = 2;
+
+  // The updated dispatch attributes
+  DispatchUpdate update = 3;
 }
 
 // Message to get a single dispatch by its ID