docs: add underscore prefix convention for private identifiers #421
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
|
@ivanauth is attempting to deploy a commit to the authzed Team on Vercel. A member of the Team first needs to authorize it. |
ivanauth
force-pushed
the
docs/underscore-prefix-identifiers
branch
from
ded56ab to
38c01d0
Compare
Document the ability to use underscore prefixes for definitions, relations, and permissions to signal that they are private/internal. This is a naming convention that helps developers distinguish between public API and internal implementation details in their schemas. Related: authzed/spicedb#2733 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
ivanauth
force-pushed
the
docs/underscore-prefix-identifiers
branch
from
38c01d0 to
4221f9d
Compare
miparnisari
approved these changes
Dec 9, 2025
miparnisari
force-pushed
the
docs/underscore-prefix-identifiers
branch
from
656aa8d to
0c5cf91
Compare
miparnisari
approved these changes
Dec 9, 2025
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Summary
Document the underscore prefix convention for marking identifiers as private/internal in SpiceDB schemas.
Changes
Added "Private/Internal Identifiers" section to schema docs covering:
Related