proposed validation as starting point

openfga · Aug 25, 2023 · 6747b2c · 6747b2c
1 parent 02af021
commit 6747b2c
Show file tree

Hide file tree

Showing 7 changed files with 1,746 additions and 1,560 deletions.
diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json
diff --git a/openfga/v1/authzmodel.proto b/openfga/v1/authzmodel.proto
@@ -22,7 +22,15 @@ message AuthorizationModel {
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "[{\"type\": \"user\"}, {\"type\":\"document\",\"relations\":{\"reader\":{\"union\":{\"child\":[{\"this\":{}},{\"computedUserset\":{\"object\":\"\",\"relation\":\"writer\"}}]}},\"writer\":{\"this\":{}}},\"metadata\":{\"relations\":{\"reader\":{\"directly_related_user_types\":[{\"type\":\"user\"}]},\"writer\":{\"directly_related_user_types\":[{\"type\":\"user\"}]}}}}]"}
   ];
 
-  map<string, Condition> conditions = 4 [json_name = "conditions"];
+  map<string, Condition> conditions = 4 [
+    json_name = "conditions",
+    (validate.rules).map.max_pairs = 100,
+    (validate.rules).map.keys.string = {
+      pattern: "^[a-zA-Z0-9]{1,25}$",
+      min_len: 1,
+      max_len: 25,
+    }
+  ];
 }
 
 message TypeDefinition {
@@ -134,13 +142,27 @@ message TupleToUserset {
 
 message Condition {
   // A unique name for the condition
-  string name = 1;
+  string name = 1 [(validate.rules).string = {
+    pattern: "^[a-zA-Z0-9]{1,25}$",
+    min_len: 1,
+    max_len: 25
+  }];
 
   // A Google CEL expression, expressed as a string.
-  string expression = 2;
+  string expression = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (validate.rules).string = {max_bytes: 5120}
+  ];
 
   // A map of parameter names to the parameter's defined type reference.
-  map<string, ConditionParamTypeRef> parameters = 3;
+  map<string, ConditionParamTypeRef> parameters = 3 [
+    (validate.rules).map.max_pairs = 25,
+    (validate.rules).map.keys.string = {
+      pattern: "^[a-zA-Z0-9]{1,25}$",
+      min_len: 1,
+      max_len: 25
+    }
+  ];
 }
 
 message ConditionParamTypeRef {
@@ -160,5 +182,5 @@ message ConditionParamTypeRef {
 
   TypeName type_name = 1 [(validate.rules).enum.defined_only = true];
 
-  repeated ConditionParamTypeRef generic_types = 2;
+  repeated ConditionParamTypeRef generic_types = 2 [(validate.rules).repeated.max_items = 5];
 }
diff --git a/openfga/v1/openfga_service.proto b/openfga/v1/openfga_service.proto
@@ -961,7 +961,15 @@ message WriteAuthorizationModelRequest {
     }
   ];
 
-  map<string, openfga.v1.Condition> conditions = 4 [json_name = "conditions"];
+  map<string, openfga.v1.Condition> conditions = 4 [
+    json_name = "conditions",
+    (validate.rules).map.max_pairs = 100,
+    (validate.rules).map.keys.string = {
+      pattern: "^[a-zA-Z0-9]{1,25}$",
+      min_len: 1,
+      max_len: 25
+    }
+  ];
 }
 
 message WriteAuthorizationModelResponse {

diff --git a/proto/openfga/v1/authzmodel.pb.go b/proto/openfga/v1/authzmodel.pb.go
diff --git a/proto/openfga/v1/authzmodel.pb.validate.go b/proto/openfga/v1/authzmodel.pb.validate.go