Describe format of an object/user and object/user id
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 51
- Forks
- 105
- Avg merge
- 10h 35m
- Merged PRs (30d)
- 17
Description
The docs note the restrictions on the relations:
From here
In OpenFGA, relations can only have alphanumeric characters, underscores and hyphens. We recommend using underscore (_) to separate words and removing prepositions. E.g.: "can create a document" can become "can_create_document" or "create_document" if you are into brevity.
It would be helpful if the same kind of restrictions would be clarified on the other elements, such as the object type and identifier.
For example, you cannot use a ':' or '#' in the identifier, but I figured this out by trial-and-error. What other restrictions/limitations are there?
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
Start with the linked OpenFGA modeling documentation page and identify the documented restrictions for object types, object identifiers, user types, and user identifiers. Done means the relevant documentation clearly lists these limitations and includes examples, including the restrictions discovered for characters such as ':' and '#'.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100