Skip to content

Commit 450e35c

Browse files
sccalabrewanharris
sccalabr
authored and
ewanharris
committed
docs:replace readable names with uuid
1 parent 9c3a4b1 commit 450e35c

7 files changed

Lines changed: 47 additions & 45 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Updated to include support for [OpenFGA 0.3.0](https://github.com/openfga/openfg
196196

197197
Changes:
198198
- [BREAKING] feat(list-objects)!: response has been changed to include the object type
199-
e.g. response that was `{"object_ids":["roadmap"]}`, will now be `{"objects":["document:roadmap"]}`
199+
e.g. response that was `{"object_ids":["roadmap"]}`, will now be `{"objects":["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]}`
200200

201201
Fixes:
202202
- fix(models): update interfaces that had incorrectly optional fields to make them required

‎README.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ Reads the relationship tuples stored in the database. It does not evaluate nor e
502502
body = ReadRequestTupleKey(
503503
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
504504
relation="viewer",
505-
object="document:roadmap",
505+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
506506
)
507507

508508
response = await fga_client.read(body)
@@ -518,7 +518,7 @@ response = await fga_client.read(body)
518518
# Find all relationship tuples where a certain user has a relationship as any relation to a certain document
519519
body = ReadRequestTupleKey(
520520
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
521-
object="document:roadmap",
521+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
522522
)
523523

524524
response = await fga_client.read(body)
@@ -551,7 +551,7 @@ response = await fga_client.read(body)
551551

552552
# Find all relationship tuples where any user has a relationship as any relation with a particular document
553553
body = ReadRequestTupleKey(
554-
object="document:roadmap",
554+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
555555
)
556556

557557
response = await fga_client.read(body)
@@ -597,7 +597,7 @@ body = ClientWriteRequest(
597597
ClientTuple(
598598
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
599599
relation="viewer",
600-
object="document:roadmap",
600+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
601601
condition=RelationshipCondition(
602602
name='ViewCountLessThan200',
603603
context=dict(
@@ -609,14 +609,14 @@ body = ClientWriteRequest(
609609
ClientTuple(
610610
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
611611
relation="viewer",
612-
object="document:budget",
612+
object="document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5",
613613
),
614614
],
615615
deletes=[
616616
ClientTuple(
617617
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
618618
relation="writer",
619-
object="document:roadmap",
619+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
620620
),
621621
],
622622
)
@@ -651,12 +651,12 @@ body = ClientWriteRequest(
651651
ClientTuple(
652652
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
653653
relation="viewer",
654-
object="document:roadmap",
654+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
655655
),
656656
ClientTuple(
657657
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
658658
relation="viewer",
659-
object="document:budget",
659+
object="document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5",
660660
condition=RelationshipCondition(
661661
name='ViewCountLessThan200',
662662
context=dict(
@@ -670,7 +670,7 @@ body = ClientWriteRequest(
670670
ClientTuple(
671671
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
672672
relation="writer",
673-
object="document:roadmap",
673+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
674674
),
675675
],
676676
)
@@ -700,7 +700,7 @@ options = {
700700
body = ClientCheckRequest(
701701
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
702702
relation="writer",
703-
object="document:roadmap",
703+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
704704
context=dict(
705705
ViewCount=100
706706
),
@@ -731,12 +731,12 @@ options = {
731731
body = [ClientCheckRequest(
732732
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
733733
relation="viewer",
734-
object="document:roadmap",
734+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
735735
contextual_tuples=[ # optional
736736
ClientTuple(
737737
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
738738
relation="editor",
739-
object="document:roadmap",
739+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
740740
),
741741
],
742742
context=dict(
@@ -745,22 +745,22 @@ body = [ClientCheckRequest(
745745
), ClientCheckRequest(
746746
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
747747
relation="admin",
748-
object="document:roadmap",
748+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
749749
contextual_tuples=[ # optional
750750
ClientTuple(
751751
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
752752
relation="editor",
753-
object="document:roadmap",
753+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
754754
),
755755
]
756756
), ClientCheckRequest(
757757
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
758758
relation="creator",
759-
object="document:roadmap",
759+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
760760
), ClientCheckRequest(
761761
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
762762
relation="deleter",
763-
object="document:roadmap",
763+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
764764
)]
765765

766766
response = await fga_client.batch_check(body, options)
@@ -769,11 +769,11 @@ response = await fga_client.batch_check(body, options)
769769
# request: {
770770
# user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
771771
# relation: "viewer",
772-
# object: "document:roadmap",
772+
# object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
773773
# contextual_tuples: [{
774774
# user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
775775
# relation: "editor",
776-
# object: "document:roadmap"
776+
# object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
777777
# }],
778778
# context=dict(
779779
# ViewCount=100
@@ -784,27 +784,27 @@ response = await fga_client.batch_check(body, options)
784784
# request: {
785785
# user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
786786
# relation: "admin",
787-
# object: "document:roadmap",
787+
# object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
788788
# contextual_tuples: [{
789789
# user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
790790
# relation: "editor",
791-
# object: "document:roadmap"
791+
# object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"
792792
# }]
793793
# }
794794
# }, {
795795
# allowed: false,
796796
# request: {
797797
# user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
798798
# relation: "creator",
799-
# object: "document:roadmap",
799+
# object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
800800
# },
801801
# error: <FgaError ...>
802802
# }, {
803803
# allowed: true,
804804
# request: {
805805
# user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
806806
# relation: "deleter",
807-
# object: "document:roadmap",
807+
# object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
808808
# }},
809809
# ]
810810
```
@@ -828,11 +828,11 @@ options = {
828828
}
829829
body = ClientExpandRequest(
830830
relation="viewer",
831-
object="document:roadmap",
831+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
832832
)
833833

834834
response = await fga_client.expand(body. options)
835-
# response = ExpandResponse({"tree": UsersetTree({"root": Node({"name": "document:roadmap#viewer", "leaf": Leaf({"users": Users({"users": ["user:81684243-9356-4421-8fbf-a4f8d36aa31b", "user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]})})})})})
835+
# response = ExpandResponse({"tree": UsersetTree({"root": Node({"name": "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a#viewer", "leaf": Leaf({"users": Users({"users": ["user:81684243-9356-4421-8fbf-a4f8d36aa31b", "user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]})})})})})
836836
```
837837

838838
#### List Objects
@@ -860,7 +860,7 @@ body = ClientListObjectsRequest(
860860
ClientTuple(
861861
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
862862
relation="writer",
863-
object="document:budget",
863+
object="document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5",
864864
),
865865
],
866866
context=dict(
@@ -869,7 +869,7 @@ body = ClientListObjectsRequest(
869869
)
870870

871871
response = await fga_client.list_objects(body)
872-
# response.objects = ["document:roadmap"]
872+
# response.objects = ["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]
873873
```
874874

875875
#### List Relations
@@ -889,13 +889,13 @@ options = {
889889
}
890890
body = ClientListRelationsRequest(
891891
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
892-
object="document:roadmap",
892+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
893893
relations=["can_view", "can_edit", "can_delete", "can_rename"],
894894
contextual_tuples=[ # optional
895895
ClientTuple(
896896
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
897897
relation="writer",
898-
object="document:budget",
898+
object="document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5",
899899
),
900900
],
901901
context=dict(
@@ -946,7 +946,7 @@ async with OpenFgaClient(configuration) as api_client:
946946
ClientTuple(
947947
user="folder:product",
948948
relation="parent",
949-
object="document:roadmap",
949+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
950950
),
951951
],
952952
)
@@ -999,7 +999,7 @@ options = {
999999
body = [ClientAssertion(
10001000
user="user:81684243-9356-4421-8fbf-a4f8d36aa31b",
10011001
relation="viewer",
1002-
object="document:roadmap",
1002+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
10031003
expectation=True,
10041004
)]
10051005

‎example/example1/example1.py‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ async def main():
180180
ClientTuple(
181181
user="user:anne",
182182
relation="writer",
183-
object="document:roadmap",
183+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
184184
condition=RelationshipCondition(
185185
name="ViewCountLessThan200",
186186
context=dict(
@@ -246,7 +246,9 @@ async def main():
246246
try:
247247
response = await fga_client.check(
248248
ClientCheckRequest(
249-
user="user:anne", relation="viewer", object="document:roadmap"
249+
user="user:anne",
250+
relation="viewer",
251+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
250252
)
251253
)
252254
print(f"Allowed: {response.allowed}")
@@ -260,7 +262,7 @@ async def main():
260262
ClientCheckRequest(
261263
user="user:anne",
262264
relation="viewer",
263-
object="document:roadmap",
265+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
264266
context=dict(ViewCount=100),
265267
)
266268
)
@@ -286,7 +288,7 @@ async def main():
286288
ClientListRelationsRequest(
287289
user="user:anne",
288290
relations=["viewer", "writer"],
289-
object="document:roadmap",
291+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
290292
)
291293
)
292294
print(f"Relations: {response}")
@@ -298,7 +300,7 @@ async def main():
298300
ClientListRelationsRequest(
299301
user="user:anne",
300302
relations=["viewer", "writer"],
301-
object="document:roadmap",
303+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
302304
context=dict(ViewCount=100),
303305
)
304306
)
@@ -331,7 +333,7 @@ async def main():
331333
ClientAssertion(
332334
user="user:anne",
333335
relation="viewer",
334-
object="document:roadmap",
336+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
335337
expectation=False,
336338
),
337339
]

‎test/api/open_fga_api_test.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ async def test_list_users(self, mock_request):
479479
{
480480
"user": "folder:product",
481481
"relation": "parent",
482-
"object": "document:roadmap",
482+
"object": "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
483483
},
484484
],
485485
)
@@ -534,7 +534,7 @@ async def test_list_users(self, mock_request):
534534
{
535535
"user": "folder:product",
536536
"relation": "parent",
537-
"object": "document:roadmap",
537+
"object": "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
538538
},
539539
],
540540
},

‎test/client/client_test.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2501,7 +2501,7 @@ async def test_list_users(self, mock_request):
25012501
ClientTuple(
25022502
user="folder:product",
25032503
relation="parent",
2504-
object="document:roadmap",
2504+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
25052505
),
25062506
],
25072507
)
@@ -2560,7 +2560,7 @@ async def test_list_users(self, mock_request):
25602560
{
25612561
"user": "folder:product",
25622562
"relation": "parent",
2563-
"object": "document:roadmap",
2563+
"object": "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
25642564
},
25652565
],
25662566
"context": {},

‎test/sync/client/client_test.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2505,7 +2505,7 @@ def test_list_users(self, mock_request):
25052505
ClientTuple(
25062506
user="folder:product",
25072507
relation="parent",
2508-
object="document:roadmap",
2508+
object="document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
25092509
),
25102510
]
25112511

@@ -2563,7 +2563,7 @@ def test_list_users(self, mock_request):
25632563
{
25642564
"user": "folder:product",
25652565
"relation": "parent",
2566-
"object": "document:roadmap",
2566+
"object": "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
25672567
},
25682568
],
25692569
"context": {},

‎test/sync/open_fga_api_test.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ async def test_list_users(self, mock_request):
484484
{
485485
"user": "folder:product",
486486
"relation": "parent",
487-
"object": "document:roadmap",
487+
"object": "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
488488
},
489489
]
490490

@@ -538,7 +538,7 @@ async def test_list_users(self, mock_request):
538538
{
539539
"user": "folder:product",
540540
"relation": "parent",
541-
"object": "document:roadmap",
541+
"object": "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
542542
},
543543
],
544544
},

0 commit comments

Comments
 (0)