Update the Read documentation to show all possible examples
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Go
- Stars
- 27
- Forks
- 24
- Avg merge
- 12d 6h
- Merged PRs (30d)
- 1
Description
Update the Read Documentation (https://github.com/openfga/api/blob/main/openfga/v1/openfga_service.proto#L29-L138) to mention all possible examples.
See Docs: https://github.com/openfga/openfga.dev/pull/988
And the SDKs: https://github.com/openfga/js-sdk/blob/main/README.md?plain=1#L329-L368
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read openfga/v1/openfga_service.proto lines 29-138, then compare the Read examples in the linked documentation and JavaScript SDK README. Update the documentation comments to cover all examples represented by those references, and verify that the proto comments are complete and consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100