Skip to content

Conversation

@brunicius
Copy link
Contributor

@brunicius brunicius commented Dec 4, 2025

Description

What problem is being solved?

A wrong relationship reference in Entitlements section in docs.
image

How is it being solved?

Replacing the reference with the correct one, in this case: member.

What changes are made to solve it?

Replaced subscriber with member.

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above] (not needed)
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected (not needed)

Summary by CodeRabbit

  • Documentation
    • Clarified entitlements configuration examples with updated organization type relationships to better illustrate access derivation patterns.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 4, 2025

Walkthrough

Documentation update to the entitlements guide example configuration, changing the metadata relation reference from subscriber to member for organization type directly_related_user_types.

Changes

Cohort / File(s) Change Summary
Documentation
docs/content/modeling/advanced/entitlements.mdx
Updated example configuration to reference member instead of subscriber in organization type metadata relations

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • rhamzeh

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title correctly identifies the main change: fixing a wrong reference in the entitlements documentation. It accurately reflects that the PR corrects an incorrect relationship reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 20fac6f and a45f273.

📒 Files selected for processing (1)
  • docs/content/modeling/advanced/entitlements.mdx (1 hunks)
🔇 Additional comments (1)
docs/content/modeling/advanced/entitlements.mdx (1)

403-414: ✓ Correct fix of metadata relationship reference.

The change from subscriber to member on line 411 is correct. The organization type's relationship to users is named member, so the metadata's directly_related_user_types must reference member here—not subscriber, which is reserved for the organization-to-plan relationship.

This aligns the verification section (lines 804–871) with the earlier configuration snippets (lines 140–188) and maintains consistency with how these relationships are used throughout the tutorial (member tuples at lines 265–285, subscriber tuples at lines 239–260).


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.

@brunicius brunicius marked this pull request as ready for review December 4, 2025 23:41
@brunicius brunicius requested a review from a team as a code owner December 4, 2025 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant