refactor(write): normalize deletes field to TupleKeyWithoutCondition (

#116)
openfga · Nov 22, 2023 · 7161d70 · 7161d70
1 parent c85ea63
commit 7161d70
Show file tree

Hide file tree

Showing 7 changed files with 2,588 additions and 2,050 deletions.
diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json
diff --git a/openfga/v1/openfga.proto b/openfga/v1/openfga.proto
@@ -43,6 +43,41 @@ message RelationshipCondition {
   google.protobuf.Struct context = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
+message TupleKeyWithoutCondition {
+  string user = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (validate.rules).string = {max_bytes: 512},
+    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+      max_length: 512,
+      example: "\"user:anne\""
+    }
+  ];
+
+  string relation = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (validate.rules).string = {
+      pattern: "^[^:#@\\s]{1,50}$",
+      ignore_empty: true
+    },
+    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+      max_length: 50,
+      example: "\"reader\""
+    }
+  ];
+
+  string object = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (validate.rules).string = {
+      pattern: "^[^\\s]{2,256}$",
+      ignore_empty: true
+    },
+    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+      max_length: 256,
+      example: "\"document:2021-budget\""
+    }
+  ];
+}
+
 message TupleKey {
   string user = 1 [
     (google.api.field_behavior) = REQUIRED,

diff --git a/openfga/v1/openfga_service.proto b/openfga/v1/openfga_service.proto
@@ -898,7 +898,7 @@ message WriteRequestTupleKey {
   RelationshipCondition condition = 4;
 }
 
-message WriteRequestTupleKeys {
+message WriteRequestWrites {
   repeated WriteRequestTupleKey tuple_keys = 1 [
     json_name = "tuple_keys",
     (google.api.field_behavior) = REQUIRED,
@@ -907,6 +907,15 @@ message WriteRequestTupleKeys {
   ];
 }
 
+message WriteRequestDeletes {
+  repeated TupleKeyWithoutCondition tuple_keys = 1 [
+    json_name = "tuple_keys",
+    (google.api.field_behavior) = REQUIRED,
+    (validate.rules).repeated.min_items = 1,
+    (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {minimum: 1}
+  ];
+}
+
 message WriteRequest {
   string store_id = 1 [
     json_name = "store_id",
@@ -915,9 +924,9 @@ message WriteRequest {
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01YCP46JKYM8FJCQ37NMBYHE5X\""}
   ];
 
-  WriteRequestTupleKeys writes = 2;
+  WriteRequestWrites writes = 2;
 
-  WriteRequestTupleKeys deletes = 3;
+  WriteRequestDeletes deletes = 3;
 
   string authorization_model_id = 4 [
     json_name = "authorization_model_id",