chore(kuma-cp) annotate required fields in protos (#2556)

* chore(kuma-cp) annotate required fields in protos

These fields will be used to mark fields as required in our docs
when generated

Signed-off-by: Bart Smykla <bartek@smykla.com>

api/mesh/v1alpha1/circuit_breaker.proto

@@ -26,10 +26,10 @@ message CircuitBreaker {
   option (kuma.mesh.resource).ws.name = "circuit-breaker";
 
   // List of selectors to match dataplanes that are sources of traffic.
-  repeated Selector sources = 1;
+  repeated Selector sources = 1 [ (doc.required) = true ];
 
   // List of selectors to match services that are destinations of traffic.
-  repeated Selector destinations = 2;
+  repeated Selector destinations = 2 [ (doc.required) = true ];
 
   message Conf {
     // Time interval between ejection analysis sweeps
@@ -102,5 +102,5 @@ message CircuitBreaker {
     Thresholds thresholds = 6;
   }
 
-  Conf conf = 3;
+  Conf conf = 3 [ (doc.required) = true ];
 }

api/mesh/v1alpha1/externalservice.proto

@@ -29,7 +29,7 @@ message ExternalService {
   // Networking describes the properties of the external service connectivity
   message Networking {
     // Address of the external service
-    string address = 1;
+    string address = 1 [ (doc.required) = true ];
 
     // TLS
     message TLS {
@@ -59,9 +59,10 @@ message ExternalService {
     TLS tls = 2;
   }
 
-  Networking networking = 1;
+  Networking networking = 1 [ (doc.required) = true ];
 
   // Tags associated with the external service,
   // e.g. kuma.io/service=web, kuma.io/protocol, version=1.0.
-  map<string, string> tags = 2 [ (validate.rules).map.min_pairs = 1 ];
+  map<string, string> tags = 2
+      [ (validate.rules).map.min_pairs = 1, (doc.required) = true ];
 }

api/mesh/v1alpha1/fault_injection.proto

@@ -26,10 +26,10 @@ message FaultInjection {
   option (kuma.mesh.resource).ws.name = "fault-injection";
 
   // List of selectors to match dataplanes that are sources of traffic.
-  repeated Selector sources = 1;
+  repeated Selector sources = 1 [ (doc.required) = true ];
 
   // List of selectors to match services that are destinations of traffic.
-  repeated Selector destinations = 2;
+  repeated Selector destinations = 2 [ (doc.required) = true ];
 
   // Conf defines several types of faults, at least one fault should be
   // specified
@@ -39,9 +39,9 @@ message FaultInjection {
     message Delay {
       // Percentage of requests on which delay will be injected, has to be in
       // [0.0 - 100.0] range
-      google.protobuf.DoubleValue percentage = 1;
+      google.protobuf.DoubleValue percentage = 1 [ (doc.required) = true ];
       // The duration during which the response will be delayed
-      google.protobuf.Duration value = 2;
+      google.protobuf.Duration value = 2 [ (doc.required) = true ];
     }
     // Delay if specified then response from the destination will be delivered
     // with a delay
@@ -53,9 +53,9 @@ message FaultInjection {
     message Abort {
       // Percentage of requests on which abort will be injected, has to be in
       // [0.0 - 100.0] range
-      google.protobuf.DoubleValue percentage = 1;
+      google.protobuf.DoubleValue percentage = 1 [ (doc.required) = true ];
       // HTTP status code which will be returned to source side
-      google.protobuf.UInt32Value httpStatus = 2;
+      google.protobuf.UInt32Value httpStatus = 2 [ (doc.required) = true ];
     }
     // Abort if specified makes source side to receive specified httpStatus code
     Abort abort = 2;
@@ -65,15 +65,15 @@ message FaultInjection {
     message ResponseBandwidth {
       // Percentage of requests on which response bandwidth limit will be
       // injected, has to be in [0.0 - 100.0] range
-      google.protobuf.DoubleValue percentage = 1;
+      google.protobuf.DoubleValue percentage = 1 [ (doc.required) = true ];
       // Limit is represented by value measure in gbps, mbps, kbps or bps, e.g.
       // 10kbps
-      google.protobuf.StringValue limit = 2;
+      google.protobuf.StringValue limit = 2 [ (doc.required) = true ];
     }
     // ResponseBandwidth if specified limits the speed of sending response body
     ResponseBandwidth response_bandwidth = 3;
   }
 
   // Configuration of FaultInjection
-  Conf conf = 3;
+  Conf conf = 3 [ (doc.required) = true ];
 }