keto
keto copied to clipboard
Define naming conventions for objects, relations, namespaces
Is your feature request related to a problem? Please describe.
Extract these with citations from the paper and document them - both in tests as well as documentation and examples.
User vs Subject
The grammar of the language defined in the paper:
<tuple> ::= <object>#<relation>@<user> <object> ::= <namespace>:<object_id> <user> ::= <user_id> | <userset> <userset> ::= <object>#<relation>
I decided to use subject
instead of user
because it is more descriptive IMO. Especially when you consider that a userset can also have the ...
relation which means any relation and basically allows the subject to be an object. See Table 1, last example:
Example Tuple in Text Notation Semantics ... ... doc:readme#parent@folder:A#...
doc:readme is in folder:A Table 1: Example relation tuples. “#...” represents a relation that does not affect the semantics of the tuple.
Vote :+1: for subject
, :-1: for user
Good, this would effectively mean, or if not considered yet please do so, that we entirely discard the word "user" from our dictionary to consistently knock out any confusion, right?
So that we have:
<tuple> ::= <object>#<relation>@<subject>
<object> ::= <namespace>:<object_id>
<subject> ::= <subject_id> | <subjectset>
<subjectset> ::= <object>#<relation>
If so, we can finally refactor UserID
and UserSet
to SubjectID
and SubjectSet
in the current code.
New name for "Zookie" used in the Keto project
As per discussion from:
- https://github.com/ory/keto/issues/311#issuecomment-728162933 ...
We (@zepatrik https://github.com/ory/keto/issues/311#issuecomment-728842524, @tacurran https://github.com/ory/keto/issues/311#issuecomment-727615735, and @robinbraemer ) want to give the "Zookie" from the Zanzibar paper a new and more descriptive name being very self explanatory as it will be used in our docs as well.
A Zookie is an opaque consistency token to each snapshot content version of a relation tuple.
These are the current options to vote for (react to vote):
- 👍 Snaptoken (@robinbraemer) - Also refered to as
snapshot token
in the docs. - 😄 Kookie (@robinbraemer) - Replace
Z
with Keto'sK
- 🎉 Ketokie (@robinbraemer) - "Cut away" in Hindi
- 🚀 Yotta (@tacurran) - (10^24) or (1000^8)
- 👀 Zoery (@tacurran) - ...has some Zo and Ory. Zoe (life) and Ory
- ❤️ Manna (@tacurran) - has two fours (2 4s: for you, for me) and is symbolic for a nourishment (
|V|a|\|\|a
->MaNNa
)
You can also suggest even better names.
As per https://github.com/ory/keto/pull/324#issuecomment-730416135 the RelationTuple's Object will be flattened out and the fields moved one layer up.
- The
object_id
string field will be renamed toobject
string field. - The namespace relationship will now concentrate on RelationTuples instead of Objects.
Hello contributors!
I am marking this issue as stale as it has not received any engagement from the community or maintainers a year. That does not imply that the issue has no merit! If you feel strongly about this issue
- open a PR referencing and resolving the issue;
- leave a comment on it and discuss ideas how you could contribute towards resolving it;
- leave a comment and describe in detail why this issue is critical for your use case;
- open a new issue with updated details and a plan on resolving the issue.
Throughout its lifetime, Ory has received over 10.000 issues and PRs. To sustain that growth, we need to prioritize and focus on issues that are important to the community. A good indication of importance, and thus priority, is activity on a topic.
Unfortunately, burnout has become a topic of concern amongst open-source projects.
It can lead to severe personal and health issues as well as opening catastrophic attack vectors.
The motivation for this automation is to help prioritize issues in the backlog and not ignore, reject, or belittle anyone.
If this issue was marked as stale erroneous you can exempt it by adding the backlog
label, assigning someone, or setting a milestone for it.
Thank you for your understanding and to anyone who participated in the conversation! And as written above, please do participate in the conversation if this topic is important to you!
Thank you 🙏✌️
Hello contributors!
I am marking this issue as stale as it has not received any engagement from the community or maintainers for a year. That does not imply that the issue has no merit! If you feel strongly about this issue
- open a PR referencing and resolving the issue;
- leave a comment on it and discuss ideas on how you could contribute towards resolving it;
- leave a comment and describe in detail why this issue is critical for your use case;
- open a new issue with updated details and a plan for resolving the issue.
Throughout its lifetime, Ory has received over 10.000 issues and PRs. To sustain that growth, we need to prioritize and focus on issues that are important to the community. A good indication of importance, and thus priority, is activity on a topic.
Unfortunately, burnout has become a topic of concern amongst open-source projects.
It can lead to severe personal and health issues as well as opening catastrophic attack vectors.
The motivation for this automation is to help prioritize issues in the backlog and not ignore, reject, or belittle anyone.
If this issue was marked as stale erroneously you can exempt it by adding the backlog
label, assigning someone, or setting a milestone for it.
Thank you for your understanding and to anyone who participated in the conversation! And as written above, please do participate in the conversation if this topic is important to you!
Thank you 🙏✌️