Re-order tuple-related fields (#97)

* re-order fields on TupleKey * mark fields as required where applicable
openfga · Sep 29, 2023 · dba5895 · dba5895
1 parent c3a581f
commit dba5895
Show file tree

Hide file tree

Showing 7 changed files with 1,768 additions and 1,736 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
@@ -44,18 +44,17 @@ message RelationshipCondition {
 }
 
 message TupleKey {
-  string object = 1 [
-    (validate.rules).string = {
-      pattern: "^[^\\s]{2,256}$",
-      ignore_empty: true
-    },
+  string user = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (validate.rules).string = {max_bytes: 512},
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-      max_length: 256,
-      example: "\"document:2021-budget\""
+      max_length: 512,
+      example: "\"user:anne\""
     }
   ];
 
   string relation = 2 [
+    (google.api.field_behavior) = REQUIRED,
     (validate.rules).string = {
       pattern: "^[^:#@\\s]{1,50}$",
       ignore_empty: true
@@ -66,11 +65,15 @@ message TupleKey {
     }
   ];
 
-  string user = 3 [
-    (validate.rules).string = {max_bytes: 512},
+  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: 512,
-      example: "\"user:anne\""
+      max_length: 256,
+      example: "\"document:2021-budget\""
     }
   ];
 

diff --git a/openfga/v1/openfga_service.proto b/openfga/v1/openfga_service.proto
@@ -859,6 +859,7 @@ message ReadResponse {
 
 message WriteRequestTupleKey {
   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,
@@ -867,6 +868,7 @@ message WriteRequestTupleKey {
   ];
 
   string relation = 2 [
+    (google.api.field_behavior) = REQUIRED,
     (validate.rules).string = {
       pattern: "^[^:#@\\s]{1,50}$",
       ignore_empty: true
@@ -878,6 +880,7 @@ message WriteRequestTupleKey {
   ];
 
   string object = 3 [
+    (google.api.field_behavior) = REQUIRED,
     (validate.rules).string = {
       pattern: "^[^\\s]{2,256}$",
       ignore_empty: true
@@ -962,6 +965,7 @@ message CheckRequest {
 
 message CheckRequestTupleKey {
   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,
@@ -970,6 +974,7 @@ message CheckRequestTupleKey {
   ];
 
   string relation = 2 [
+    (google.api.field_behavior) = REQUIRED,
     (validate.rules).string = {
       pattern: "^[^:#@\\s]{1,50}$",
       ignore_empty: true
@@ -981,6 +986,7 @@ message CheckRequestTupleKey {
   ];
 
   string object = 3 [
+    (google.api.field_behavior) = REQUIRED,
     (validate.rules).string = {
       pattern: "^[^\\s]{2,256}$",
       ignore_empty: true
@@ -1024,25 +1030,26 @@ message ExpandRequest {
 }
 
 message ExpandRequestTupleKey {
-  string object = 1 [
+  string relation = 1 [
+    (google.api.field_behavior) = REQUIRED,
     (validate.rules).string = {
-      pattern: "^[^\\s]{2,256}$",
+      pattern: "^[^:#@\\s]{1,50}$",
       ignore_empty: true
     },
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-      max_length: 256,
-      example: "\"document:2021-budget\""
+      max_length: 50,
+      example: "\"reader\""
     }
   ];
-
-  string relation = 2 [
+  string object = 2 [
+    (google.api.field_behavior) = REQUIRED,
     (validate.rules).string = {
-      pattern: "^[^:#@\\s]{1,50}$",
+      pattern: "^[^\\s]{2,256}$",
       ignore_empty: true
     },
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-      max_length: 50,
-      example: "\"reader\""
+      max_length: 256,
+      example: "\"document:2021-budget\""
     }
   ];
 }