Skip to content

docs: update abac example#2920

Merged
omer-topal merged 1 commit intomasterfrom
omer/docs-example-update
Apr 28, 2026
Merged

docs: update abac example#2920
omer-topal merged 1 commit intomasterfrom
omer/docs-example-update

Conversation

@omer-topal
Copy link
Copy Markdown
Contributor

@omer-topal omer-topal commented Apr 28, 2026

Summary by CodeRabbit

  • Documentation
    • Enhanced modeling documentation with explicit clarifications on traversal semantics behavior consistency between relation properties and how permission evaluations apply across multiple related entities
    • Improved attribute-based access control use case examples with clearer explanations of subject type definitions and updated evaluation sequences that better demonstrate permission checking behavior across multiple organizations

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 44db4225-ce6a-4a88-aba5-ed452d8c026e

📥 Commits

Reviewing files that changed from the base of the PR and between 8d6ed57 and dec011e.

📒 Files selected for processing (2)
  • docs/getting-started/modeling.mdx
  • docs/use-cases/abac.mdx

📝 Walkthrough

Walkthrough

Documentation updates clarifying traversal semantics in the permission modeling language. One change adds an explicit rule about relation/permission evaluation across multiple entities, while the other updates an ABAC hierarchical example with simplified traces and union semantics behavior.

Changes

Cohort / File(s) Summary
Documentation Clarifications
docs/getting-started/modeling.mdx, docs/use-cases/abac.mdx
Adds explicit modeling rule clarifying traversal semantics for relation.userset and relation.permission. Rewrites hierarchical ABAC example to simplify evaluation traces, removes intermediate relationship paths, and adds a Warning demonstrating union semantics when departments link to multiple organizations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • ucatbas

Poem

🐰 Through relations we hop, and permissions align,
When entities traverse, their semantics align fine!
Multiple paths evaluated, set operations flow,
Documentation now clearer—semantics now glow! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: update abac example' accurately describes the main change, which involves updating the ABAC documentation example with clarifications and revised semantics.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch omer/docs-example-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.61%. Comparing base (8d6ed57) to head (dec011e).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2920      +/-   ##
==========================================
+ Coverage   82.58%   82.61%   +0.03%     
==========================================
  Files          74       74              
  Lines        8300     8300              
==========================================
+ Hits         6854     6856       +2     
+ Misses        910      909       -1     
+ Partials      536      535       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@omer-topal
Copy link
Copy Markdown
Contributor Author

#2911 #2908

@omer-topal omer-topal merged commit 5830dd9 into master Apr 28, 2026
15 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 28, 2026
@omer-topal omer-topal deleted the omer/docs-example-update branch April 28, 2026 20:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant