Skip to content

chore(docs): document transform command for authorization models #566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
aaguiarz merged 1 commit into from
Aug 22, 2025
Merged

chore(docs): document transform command for authorization models #566

aaguiarz merged 1 commit into from
Aug 22, 2025

Conversation

@aaguiarz
Copy link
Member

@aaguiarz aaguiarz commented Aug 22, 2025 •
edited by coderabbitai bot
Loading

Sometimes users search for a "convert" command, so I added the "convert" keyword too

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
    • Clarified the Transform command in README by adding a brief description before relevant sections, noting it converts authorization model formats (.fga, .json, .mod).
    • Applied the clarification in two locations for consistency.
    • No functional or behavioral changes; commands and examples remain unchanged.
    • Improves discoverability and understanding for users performing format conversions.

@aaguiarz
Document transform command for authorization models
fe6cfde 
Sometimes users search for a "convert" command, so I added the "convert" keyword too
@aaguiarz aaguiarz requested review from a team as code owners August 22, 2025 17:24
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 22, 2025 •
edited
Loading

Walkthrough

Adds two explanatory sentences to README documenting that the transform command converts between .fga, .json, and .mod authorization model formats. No code or behavioral changes.

Changes

Cohort / File(s) Summary
Docs: README updates
README.md		 Inserted a descriptive sentence about the transform command’s purpose in two places within the Transform an Authorization Model section. No other content or behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/improve-transform-doc

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Aug 22, 2025
View reviewed changes
Copy link
Contributor

@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)
README.md (1)

663-664: Confirm extension/name consistency for modular models (.mod vs fga.mod)

Elsewhere the README references “fga.mod” and the “modular” format; here you introduce “.mod”. Ensure we consistently use the canonical filename/extension users should expect (e.g., “fga.mod” vs generic “.mod”), and align with the CLI flags that use modular.

Questions to verify:

  • Do we officially recommend “fga.mod” as the filename, or any “.mod” file?
  • Should the parenthetical read: ("fga", "json", "modular") for format names, and (.fga, .json, fga.mod) for common filenames?
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 6320eee and fe6cfde.

📒 Files selected for processing (1)
  • README.md (1 hunks)
⏰ 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). (3)
  • GitHub Check: Test Release Process
  • GitHub Check: Tests
  • GitHub Check: Analyze (go)
🔇 Additional comments (1)
README.md (1)

663-664: The verification script has been dispatched to locate any existing “convert” alias on the transform command. I’ll review the findings once they arrive.

@rhamzeh rhamzeh changed the title Document transform command for authorization models chore(docs): document transform command for authorization models Aug 22, 2025
@aaguiarz aaguiarz added this pull request to the merge queue Aug 22, 2025
Merged via the queue into main with commit bd345de Aug 22, 2025
22 checks passed
@aaguiarz aaguiarz deleted the chore/improve-transform-doc branch August 22, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@rhamzeh rhamzeh rhamzeh approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aaguiarz @rhamzeh