docs: add StreamedListObjects documentation

[daniel-jonathan]

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

• feat: add streamedListObjects for unlimited object retrieval js-sdk#280
• feat: add streamedListObjects for unlimited object retrieval sdk-generator#654
• [All SDKs] Support streaming endpoints (StreamedListObjects) 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.

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

PR Preview Action v1.6.2
🚀 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.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

docs/content/getting-started/perform-list-objects.mdx (1)

187-190: Add context or reference for the OPENFGA_LIST_OBJECTS_DEADLINE environment variable.

The documentation mentions OPENFGA_LIST_OBJECTS_DEADLINE as controlling the timeout limit, but does not explain its format, default value, or where to find configuration guidance. Consider adding a link to configuration documentation or brief inline explanation (e.g., unit of time, typical range) to help readers configure this appropriately.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4710a2 and 4f1b5eb.

📒 Files selected for processing (1)

• docs/content/getting-started/perform-list-objects.mdx (2 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). (4)

• GitHub Check: deploy-preview
• GitHub Check: Test deployment
• GitHub Check: Run Checks
• GitHub Check: markdown-link-check-md

🔇 Additional comments (2)

docs/content/getting-started/perform-list-objects.mdx (2)

240-244: StreamedListObjects API link verified and correctly formatted.

The endpoint /api/service#Relationship%20Queries/StreamedListObjects is properly documented and actively referenced throughout the codebase (relationship-queries.mdx, tuples-api-best-practices.mdx). The link structure matches the established pattern used for other Relationship Queries endpoints (Check, ListObjects, ListUsers).

---

192-194: SDK availability note is accurate—both method names verified in official documentation.

The Node.js SDK exposes the streamedListObjects method, and the Python SDK exposes streamed_list_objects. The documented SDK availability statement correctly indicates that streaming functionality is available in Node.js and Python SDKs only, matching the actual SDK implementations.