docs: replace readable names with uuid (#146)

* docs:replace readable names with uuid * Update CONTRIBUTING.md --------- Co-authored-by: sccalabr <[email protected]>
openfga · Nov 15, 2024 · 17fd63c · 17fd63c
1 parent 6bd5567
commit 17fd63c
Show file tree

Hide file tree

Showing 5 changed files with 104 additions and 104 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -195,7 +195,7 @@ Updated to include support for [OpenFGA 0.3.0](https://github.com/openfga/openfg
 
 Changes:
 - [BREAKING] feat(list-objects)!: response has been changed to include the object type
-    e.g. response that was `{"object_ids":["roadmap"]}`, will now be `{"objects":["document:roadmap"]}`
+    e.g. response that was `{"object_ids":["roadmap"]}`, will now be `{"objects":["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]}`
 
 Fixes:
 - [BREAKING] fix(models): update interfaces that had incorrectly optional fields to make them required

diff --git a/README.md b/README.md
@@ -460,13 +460,13 @@ Reads the relationship tuples stored in the database. It does not evaluate nor e
 body := ClientReadRequest{
     User:     openfga.PtrString("user:81684243-9356-4421-8fbf-a4f8d36aa31b"),
     Relation: openfga.PtrString("viewer"),
-    Object:   openfga.PtrString("document:roadmap"),
+    Object:   openfga.PtrString("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
 }
 
 // Find all relationship tuples where a certain user has a relationship as any relation to a certain document
 body := ClientReadRequest{
     User:     openfga.PtrString("user:81684243-9356-4421-8fbf-a4f8d36aa31b"),
-    Object:   openfga.PtrString("document:roadmap"),
+    Object:   openfga.PtrString("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
 }
 
 // Find all relationship tuples where a certain user is a viewer of any document
@@ -478,7 +478,7 @@ body := ClientReadRequest{
 
 // Find all relationship tuples where any user has a relationship as any relation with a particular document
 body := ClientReadRequest{
-    Object:   openfga.PtrString("document:roadmap"),
+    Object:   openfga.PtrString("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
 }
 
 // Read all stored relationship tuples
@@ -511,16 +511,16 @@ body := ClientWriteRequest{
     Writes: &[]ClientTupleKey{ {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "viewer",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     }, {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "viewer",
-        Object:   "document:budget",
+        Object:   "document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5",
     } },
     Deletes: &[]ClientTupleKeyWithoutCondition{ {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "writer",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     } }
 }
 
@@ -544,16 +544,16 @@ body := ClientWriteRequest{
     Writes: &[]ClientTupleKey{ {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "viewer",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     }, {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "viewer",
-        Object:   "document:budget",
+        Object:   "document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5",
     } },
 	  Deletes: &[]ClientTupleKeyWithoutCondition{ {
       User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
       Relation: "writer",
-      Object:   "document:roadmap",
+      Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     } }
 }
 
@@ -601,11 +601,11 @@ Check if a user has a particular relation with an object.
 body := ClientCheckRequest{
     User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "viewer",
-    Object:   "document:roadmap",
+    Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     ContextualTuples: &[]ClientTupleKey{ {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "editor",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     } },
 }
 
@@ -639,29 +639,29 @@ options := ClientBatchCheckOptions{
 body := ClientBatchCheckBody{ {
     User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "viewer",
-    Object:   "document:roadmap",
+    Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     ContextualTuples: &[]ClientTupleKey{ {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "editor",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     } },
 }, {
     User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "admin",
-    Object:   "document:roadmap",
+    Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     ContextualTuples: &[]ClientTupleKey{ {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "editor",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     } },
 }, {
     User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "creator",
-    Object:   "document:roadmap",
+    Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 }, {
     User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "deleter",
-    Object:   "document:roadmap",
+    Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 } }
 
 data, err := fgaClient.BatchCheck(context.Background()).Body(requestBody).Options(options).Execute()
@@ -672,11 +672,11 @@ data = [{
   Request: {
     User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "viewer",
-    Object: "document:roadmap",
+    Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     ContextualTuples: [{
       User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
       Relation: "editor",
-      Object: "document:roadmap"
+      Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
     }]
   },
   HttpResponse: ...
@@ -685,11 +685,11 @@ data = [{
   Request: {
     User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "admin",
-    Object: "document:roadmap",
+    Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     ContextualTuples: [{
       User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
       Relation: "editor",
-      Object: "document:roadmap"
+      Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
     }]
   },
   HttpResponse: ...
@@ -698,7 +698,7 @@ data = [{
   Request: {
     User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "creator",
-    Object: "document:roadmap",
+    Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
   },
   HttpResponse: ...,
   Error: <FgaError ...>
@@ -707,7 +707,7 @@ data = [{
   Request: {
     User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     Relation: "deleter",
-    Object: "document:roadmap",
+    Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
   }},
   HttpResponse: ...,
 ]
@@ -729,11 +729,11 @@ options := ClientExpandOptions{
 }
 body := ClientExpandRequest{
     Relation: "viewer",
-    Object:   "document:roadmap",
+    Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 }
 data, err := fgaClient.Expand(context.Background()).Body(requestBody).Options(options).Execute()
 
-// data.Tree.Root = {"name":"document:roadmap#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b","user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]}}}
+// data.Tree.Root = {"name":"document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b","user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]}}}
 ```
 
 #### List Objects
@@ -760,15 +760,15 @@ body := ClientListObjectsRequest{
     }, {
         User:     "folder:product",
         Relation: "parent",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     } },
 }
 data, err := fgaClient.ListObjects(context.Background()).
   Body(requestBody).
   Options(options).
   Execute()
 
-// data.Objects = ["document:roadmap"]
+// data.Objects = ["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]
 ```
 
 #### List Relations
@@ -786,12 +786,12 @@ options := ClientListRelationsOptions{
 }
 body := ClientListRelationsRequest{
     User:      "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
-    Object:    "document:roadmap",
+    Object:    "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     Relations: []string{"can_view", "can_edit", "can_delete", "can_rename"},
     ContextualTuples: &[]ClientTupleKey{ {
         User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation: "editor",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     } },
 }
 data, err := fgaClient.ListRelations(context.Background()).
@@ -837,7 +837,7 @@ requestBody := ClientListUsersRequest{
     }, {
         User:     "folder:product",
         Relation: "parent",
-        Object:   "document:roadmap",
+        Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
     }},
     Context: &map[string]interface{}{"ViewCount": 100},
 }
@@ -886,7 +886,7 @@ requestBody := ClientWriteAssertionsRequest{
     ClientAssertion{
         User:        "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
         Relation:    "can_view",
-        Object:      "document:roadmap",
+        Object:      "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
         Expectation: true,
     },
 }

diff --git a/api_open_fga_test.go b/api_open_fga_test.go
@@ -538,7 +538,7 @@ func TestOpenFgaApi(t *testing.T) {
 			TupleKey: CheckRequestTupleKey{
 				User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 				Relation: "viewer",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			},
 			AuthorizationModelId: PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
 		}
@@ -591,7 +591,7 @@ func TestOpenFgaApi(t *testing.T) {
 				TupleKeys: []TupleKey{{
 					User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 					Relation: "viewer",
-					Object:   "document:roadmap",
+					Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 				}},
 			},
 			AuthorizationModelId: PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
@@ -637,7 +637,7 @@ func TestOpenFgaApi(t *testing.T) {
 				TupleKeys: []TupleKeyWithoutCondition{{
 					User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 					Relation: "viewer",
-					Object:   "document:roadmap",
+					Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 				}},
 			},
 			AuthorizationModelId: PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
@@ -672,7 +672,7 @@ func TestOpenFgaApi(t *testing.T) {
 	t.Run("Expand", func(t *testing.T) {
 		test := TestDefinition{
 			Name:           "Expand",
-			JsonResponse:   `{"tree":{"root":{"name":"document:roadmap#viewer","union":{"nodes":[{"name": "document:roadmap#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b"]}}}]}}}}`,
+			JsonResponse:   `{"tree":{"root":{"name":"document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a#viewer","union":{"nodes":[{"name": "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b"]}}}]}}}}`,
 			ResponseStatus: 200,
 			Method:         "POST",
 			RequestPath:    "expand",
@@ -681,7 +681,7 @@ func TestOpenFgaApi(t *testing.T) {
 		requestBody := ExpandRequest{
 			TupleKey: ExpandRequestTupleKey{
 				Relation: "viewer",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			},
 			AuthorizationModelId: PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
 		}
@@ -720,7 +720,7 @@ func TestOpenFgaApi(t *testing.T) {
 	t.Run("Read", func(t *testing.T) {
 		test := TestDefinition{
 			Name:           "Read",
-			JsonResponse:   `{"tuples":[{"key":{"user":"user:81684243-9356-4421-8fbf-a4f8d36aa31b","relation":"viewer","object":"document:roadmap"},"timestamp": "2000-01-01T00:00:00Z"}]}`,
+			JsonResponse:   `{"tuples":[{"key":{"user":"user:81684243-9356-4421-8fbf-a4f8d36aa31b","relation":"viewer","object":"document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"},"timestamp": "2000-01-01T00:00:00Z"}]}`,
 			ResponseStatus: 200,
 			Method:         "POST",
 			RequestPath:    "read",
@@ -730,7 +730,7 @@ func TestOpenFgaApi(t *testing.T) {
 			TupleKey: &ReadRequestTupleKey{
 				User:     PtrString("user:81684243-9356-4421-8fbf-a4f8d36aa31b"),
 				Relation: PtrString("viewer"),
-				Object:   PtrString("document:roadmap"),
+				Object:   PtrString("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
 			},
 		}
 
@@ -772,7 +772,7 @@ func TestOpenFgaApi(t *testing.T) {
 	t.Run("ReadChanges", func(t *testing.T) {
 		test := TestDefinition{
 			Name:           "ReadChanges",
-			JsonResponse:   `{"changes":[{"tuple_key":{"user":"user:81684243-9356-4421-8fbf-a4f8d36aa31b","relation":"viewer","object":"document:roadmap"},"operation":"TUPLE_OPERATION_WRITE","timestamp": "2000-01-01T00:00:00Z"}],"continuation_token":"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ=="}`,
+			JsonResponse:   `{"changes":[{"tuple_key":{"user":"user:81684243-9356-4421-8fbf-a4f8d36aa31b","relation":"viewer","object":"document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"},"operation":"TUPLE_OPERATION_WRITE","timestamp": "2000-01-01T00:00:00Z"}],"continuation_token":"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ=="}`,
 			ResponseStatus: 200,
 			Method:         "GET",
 			RequestPath:    "changes",
@@ -820,7 +820,7 @@ func TestOpenFgaApi(t *testing.T) {
 	t.Run("ListObjects", func(t *testing.T) {
 		test := TestDefinition{
 			Name:           "ListObjects",
-			JsonResponse:   `{"objects":["document:roadmap"]}`,
+			JsonResponse:   `{"objects":["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]}`,
 			ResponseStatus: 200,
 			Method:         "POST",
 			RequestPath:    "list-objects",
@@ -839,7 +839,7 @@ func TestOpenFgaApi(t *testing.T) {
 				}, {
 					User:     "folder:product",
 					Relation: "parent",
-					Object:   "document:roadmap",
+					Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 				}},
 			},
 		}
@@ -912,7 +912,7 @@ func TestOpenFgaApi(t *testing.T) {
 			}, {
 				User:     "folder:product",
 				Relation: "parent",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			}},
 			Context: &map[string]interface{}{"ViewCount": 100},
 		}
@@ -978,7 +978,7 @@ func TestOpenFgaApi(t *testing.T) {
 			TupleKey: CheckRequestTupleKey{
 				User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 				Relation: "viewer",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			},
 		}
 
@@ -1042,7 +1042,7 @@ func TestOpenFgaApi(t *testing.T) {
 			TupleKey: CheckRequestTupleKey{
 				User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 				Relation: "viewer",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			},
 		}
 
@@ -1099,7 +1099,7 @@ func TestOpenFgaApi(t *testing.T) {
 			TupleKey: CheckRequestTupleKey{
 				User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 				Relation: "viewer",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			},
 		}
 
@@ -1163,7 +1163,7 @@ func TestOpenFgaApi(t *testing.T) {
 			TupleKey: CheckRequestTupleKey{
 				User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 				Relation: "viewer",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			},
 		}
 
@@ -1234,7 +1234,7 @@ func TestOpenFgaApi(t *testing.T) {
 			TupleKey: CheckRequestTupleKey{
 				User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 				Relation: "viewer",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			},
 		}
 
@@ -1295,7 +1295,7 @@ func TestOpenFgaApi(t *testing.T) {
 			TupleKey: CheckRequestTupleKey{
 				User:     "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
 				Relation: "viewer",
-				Object:   "document:roadmap",
+				Object:   "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
 			},
 		}