Skip to content

Conversation

@afzal442
Copy link

@afzal442 afzal442 commented Jan 20, 2025

Closes: #815

Description

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 Write API tuple limit documentation to explicitly explain that the limit is configurable and applies to the combined sum of writes and deletes, with updated reference to configuration options.

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

@afzal442 afzal442 requested a review from a team as a code owner January 20, 2025 16:46
@afzal442
Copy link
Author

cc @rhamzeh

Copy link
Member

@rhamzeh rhamzeh left a comment

Choose a reason for hiding this comment

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

Thanks @afzal442 - was avoiding merging until the new page was available, can I ask you to link to it now?

@afzal442 afzal442 requested a review from rhamzeh March 11, 2025 17:37
rhamzeh
rhamzeh previously approved these changes Mar 11, 2025
@rhamzeh rhamzeh enabled auto-merge (squash) March 11, 2025 17:39
@rhamzeh rhamzeh self-assigned this May 8, 2025
auto-merge was automatically disabled November 24, 2025 05:23

Head branch was pushed to by a user without write access

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 24, 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

This PR corrects the transactional Write API tuple limit in documentation from 10 to 100, the actual default value. It clarifies the limit is configurable via --max-tuples-per-write and adds a link to the configuration schema documentation.

Changes

Cohort / File(s) Summary
Documentation Update
docs/content/interacting/transactional-writes.mdx
Updated Write API tuple limit description from 10 to 100 (default), added configurable flag reference (--max-tuples-per-write), and linked to configuration schema documentation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single documentation file with a straightforward factual correction and clarification

Possibly related PRs

Suggested reviewers

  • rhamzeh

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is partially related but unclear—it mentions adding a config link and 'support it to by default info' which are vague; unclear grammar makes the primary objective hard to discern. Clarify the title to directly state the change: 'fix: correct tuple limit from 10 to 100 and add config schema link' or similar.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed The PR addresses all requirements from issue #815: corrects the tuple limit default value, indicates configurability, and adds documentation link to config schema.
Out of Scope Changes check ✅ Passed All changes are directly scoped to the issue requirements: documentation updates to transactional-writes.mdx regarding tuple limits and configurability.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

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.

Value for tuples in transactional writes is incorrect

3 participants