Replace readable names by uuids in the readme, tests and examples

[rhamzeh]

For example here in the .NET SDK

var body = new ClientCheckRequest {
    User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
    Relation = "writer",
    Object = "document:roadmap"
};

can be written as:

var body = new ClientCheckRequest {
    User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
    Relation = "writer",
    Object = "document:9f81b5ba-cd00-450e-8127-3786c92aeab9"
};

[srose]

I am wondering why uuids are favored over readable names especially in readmes, tests and examples. Any small hint is appreciated...

[rhamzeh]

@srose - way too late of a reply, but basically the fact that we use human readable IDs in our docs have been interpreted by many users that that's what they should do despite our many warnings across the documentation.

We want to stress that OpenFGA does not need any identifiable data other than the unique identifier of that element in your DB.

I agree that it is much easier to follow when we have human readable ids in our documentation, but people are mistaking this to be our recommended way.

Will chat a bit more with the team if we can pepper more warnings across the READMEs and documentation in lieu of this

[sccalabr]

Id like to give this a try if its still open

[ewanharris]

@sccalabr, this issue is still free. As the issue description states, we're looking to replace any usage of a readable name in the id portion of user or object field with a uuid (so "document:roadmap" becomes "document:9f81b5ba-cd00-450e-8127-3786c92aeab9". It would be awesome if this is done across all our SDKs. I'd recommend doing it in this repo, in the template directory of each SDK, you'll most like just need to look at the README_ files.

Please let me know if you need any guidance

[srose]

@rhamzeh thank you for your reply. sorry to have it missed because of message overflow in my github-inbox. Totally agree after your explanation.

@sccalabr let me know if I can somehow be helpful.