Skip to content

Enhance documentation for tuple write command output format#926

Merged
ewanharris merged 4 commits intoopenfga:mainfrom
Siddhant-K-code:docs/tuple-write-output
Jan 22, 2025
Merged

Enhance documentation for tuple write command output format#926
ewanharris merged 4 commits intoopenfga:mainfrom
Siddhant-K-code:docs/tuple-write-output

Conversation

@Siddhant-K-code
Copy link
Member

Description

This PR enhances the documentation for the tuple write command output format in the CLI documentation.

Changes:

  • Added detailed explanation of all JSON response fields:
    • successful/failed tuples
    • total_count
    • successful_count
    • failed_count
  • Documented the behavior of --hide-imported-tuples flag

References

Related openfga/cli#437

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

@ewanharris ewanharris merged commit a6cc793 into openfga:main Jan 22, 2025
9 of 10 checks passed
@Siddhant-K-code Siddhant-K-code deleted the docs/tuple-write-output branch January 22, 2025 16:53
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.

2 participants