Skip to content

Conversation

@aaguiarz
Copy link
Member

@aaguiarz aaguiarz commented Sep 17, 2025

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

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]
  • 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

Summary by CodeRabbit

  • Documentation
    • Updated README instructions to reference the correct test configuration filename in both the instruction text and example block.
    • Clarified test invocation guidance for consistency and accuracy.
    • No functional or API changes.

@aaguiarz aaguiarz requested review from a team as code owners September 17, 2025 14:14
@coderabbitai
Copy link

coderabbitai bot commented Sep 17, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Updated documentation in stores/abac-with-rebac/README.md to reference store.fga.yaml instead of store.yaml in both an instruction line and an example block. No code or API changes.

Changes

Cohort / File(s) Summary
Docs: filename reference update
stores/abac-with-rebac/README.md
Replaced occurrences of store.yaml with store.fga.yaml in instructions and example block.

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
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'fix: update test command in README for FGA' directly and specifically describes the main change: updating a test command in the README file for FGA. It is concise, clear, and accurately reflects the changeset.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
stores/abac-with-rebac/README.md (1)

64-64: Use ./store.fga.yaml and normalize README test commands repo-wide

Change is correct — prefer ./store.fga.yaml for clarity. Repo search shows many README files still call fga model test --tests store.yaml; update those to fga model test --tests ./store.fga.yaml.

-2. In the `abac-with-rebac` directory, run `fga model test --tests store.fga.yaml`
+2. In the `abac-with-rebac` directory, run `fga model test --tests ./store.fga.yaml`

Examples of affected files: stores/slack/README.md:118, stores/superadmin/README.md:26, stores/role-assignments/README.md:78, stores/iot/README.md:83, stores/expenses/README.md:79, stores/github/README.md:106, stores/developer-portal/README.md:27, stores/gdrive/README.md:120, stores/custom-roles/README.md:113, stores/entitlements/README.md:106.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f96cd08 and ffca30a.

📒 Files selected for processing (1)
  • stores/abac-with-rebac/README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-07T12:33:08.458Z
Learnt from: CR
PR: openfga/sample-stores#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-07T12:33:08.458Z
Learning: Applies to **/*.fga.yaml : Use the .fga.yaml file format to define and test OpenFGA authorization models, including model, tuples, and tests sections

Applied to files:

  • stores/abac-with-rebac/README.md
📚 Learning: 2025-08-07T12:33:08.458Z
Learnt from: CR
PR: openfga/sample-stores#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-07T12:33:08.458Z
Learning: Applies to **/*.fga.yaml : Define test cases for OpenFGA models in the tests section of .fga.yaml files, including check, list_objects, and list_users tests

Applied to files:

  • stores/abac-with-rebac/README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Socket Security: Pull Request Alerts

@rhamzeh rhamzeh changed the title Update test command in README for FGA fix: update test command in README for FGA Nov 18, 2025
Copilot AI review requested due to automatic review settings November 18, 2025 16:00
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR corrects a documentation error in the README file for the abac-with-rebac store example. The test command previously referenced an incorrect filename (store.yaml) and now correctly references store.fga.yaml, which is the actual configuration file present in the directory.

Key Changes

  • Updated the FGA CLI test command to use the correct filename store.fga.yaml instead of store.yaml

@aaguiarz aaguiarz merged commit 79fa8c1 into main Nov 18, 2025
13 checks passed
@aaguiarz aaguiarz deleted the chore/fix-example branch November 18, 2025 16:02
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.

4 participants