openfga.dev icon indicating copy to clipboard operation
openfga.dev copied to clipboard
verified publisher icon openfga

docs: add StreamedListObjects documentation

Open daniel-jonathan opened this issue 3 months ago • 2 comments

Summary

Adds StreamedListObjects documentation to the List Objects guide.

Changes

  • Add Streamed List Objects section to perform-list-objects.mdx
  • Include Node.js and Python SDK code examples
  • Add SDK availability note
  • Add StreamedListObjects API link to Related Sections

Related

  • openfga/js-sdk#280
  • openfga/sdk-generator#654
  • openfga/sdk-generator#76

Summary by CodeRabbit

  • Documentation
    • Added new documentation section for Streamed List Objects, including streaming behavior details and timeout-based result limits.
    • Provided usage examples in JavaScript and Python.
    • Updated related sections with link to Streamed List Objects API documentation.
    • Noted feature availability in specific SDKs.

daniel-jonathan avatar Nov 03 '25 19:11 daniel-jonathan

[!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

Documentation update for the perform-list-objects guide, adding a new "Streamed List Objects" section describing streaming behavior, timeout-based result limits via OPENFGA_LIST_OBJECTS_DEADLINE, SDK availability notes, and usage examples in JavaScript and Python.

Changes

Cohort / File(s) Summary
Documentation: Streaming List Objects
docs/content/getting-started/perform-list-objects.mdx		 Adds new "Streamed List Objects" section with streaming behavior explanation, timeout limit configuration details, SDK availability notes (Node.js and Python only), JavaScript and Python code examples, and related API documentation link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Documentation content addition with no code logic changes
  • Review focuses on accuracy of descriptions, example correctness, and link validity

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add StreamedListObjects documentation' directly and clearly describes the main change - adding documentation for the StreamedListObjects feature to the getting-started guide.

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.

coderabbitai[bot] avatar Nov 03 '25 19:11 coderabbitai[bot]

PR Preview Action v1.6.2 :---: |

:rocket: View preview at
https://openfga.github.io/openfga.dev/pr-preview/pr-1135/

|
Built to branch gh-pages at 2025-11-19 17:36 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

github-actions[bot] avatar Nov 03 '25 19:11 github-actions[bot]