feat: document new self feature #499
Merged
+59
−27
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
miparnisari
reviewed
Jan 23, 2026
miparnisari
reviewed
Jan 23, 2026
miparnisari
reviewed
Jan 23, 2026
miparnisari
reviewed
Jan 23, 2026
| only view a document if the user is related to the document as viewer and editing is enabled for the | ||
| document (this is the same authorization logic used in the wildcard example above). | ||
|
|
||
| In the example below, to enable editing for a document, a self relationship using the `edit_enabled` relation must be written. |
Contributor
There was a problem hiding this comment.
Suggested change
| In the example below, to enable editing for a document, a self relationship using the `edit_enabled` relation must be written. | |
| To enable editing for a document, a loop relationship using the `edit_enabled` relation must be written. |
please do a search in the entire repo for "self" and make sure we change to "loop" where applicable
miparnisari
reviewed
Jan 23, 2026
| Self relationships relate an object to itself. | ||
| A self relationship is walked with an [arrow](/spicedb/concepts/schema#--arrow) back to an object's self. | ||
| Loop relationships relate an object to itself. | ||
| A loop relationship is walked with an [arrow](/spicedb/concepts/schema#--arrow) back to an object's self. |
Contributor
There was a problem hiding this comment.
i still don't know what a loop relationship is and this is talking about how it is used. i'd remove this line, we mention the arrow down below with the example
Co-authored-by: Maria Ines Parnisari <maria.ines.parnisari@authzed.com>
Co-authored-by: Maria Ines Parnisari <maria.ines.parnisari@authzed.com>
tstirrat15
force-pushed
the
document-new-self-feature
branch
2 times, most recently
from
50b8b16 to
4903b78
Compare
miparnisari
approved these changes
Jan 23, 2026
Co-authored-by: Maria Ines Parnisari <maria.ines.parnisari@authzed.com>
tstirrat15
force-pushed
the
document-new-self-feature
branch
from
4903b78 to
5e37c89
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Counterpart to authzed/spicedb#2785. This PR should be held until v1.49.0 is released.
This adds documentation for the
selffeature implemented in the aforementioned PR.Changes
selfkeyword to the schema reference pageTesting
Review