updating the types of valid read calls someone can make

[tylernix]

Including more ways to call the Read API that were not previously documented.

Description

Updating the documentation to include all 7 ways you can use the Read API to get relationship tuples.

1. Read a tuple related to a particular user, relation, and object
2. Read all tuples related to a particular user, relation, and object type
3. Read all tuples related to a particular user and object with any relation
4. Read all tuples related to a particular user and object type with any relation
5. Read all tuples related to a particular relation and object for any user
6. Read all tuples related to a particular object with any user or relation
7. Read all tuples for any user, relation, or object

1,4,6,7 were previously not documented.

References

closes #971

Review Checklist

• I have clicked on "allow edits by maintainers".
• I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
• The correct base branch is being used, if not main
• I have added tests to validate that the change in functionality is working as expected

[rhamzeh]

@ryanpq can we add a ticket to the SDK Generator to update the README's of the SDKs to match this?

e.g. https://github.com/openfga/js-sdk?tab=readme-ov-file#read-relationship-tuples

The one missing from the SDK documentation is (5) `Read all tuples related to a particular relation and object for any user.

Also let's update the API Documentation to match

[github-actions]

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2025-03-21 22:18 UTC