chore: make streamed list objects client methods public

[SoulPancake]

Making streamed list objects client methods, examples and documentation public

Summary by CodeRabbit

• New Features

  • StreamedListObjects endpoint now available for streaming object listing without pagination limits. Objects are yielded as they are collected rather than batched, making it ideal for handling large result sets.

• Documentation

  • Updated README with comprehensive StreamedListObjects usage examples, including configuration options and consumption patterns.

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

[coderabbitai]

Walkthrough

This change exposes the StreamedListObjects streaming API by converting previously unexported client methods to public exports, updates documentation and examples to reflect the new public interface, and adds changelog entries to document the feature.

Changes

Cohort / File(s)	Summary
Public API Export client/client.go	Promotes streamedListObjects and streamedListObjectsExecute methods to public (capitalized) exports in the SdkClient interface and OpenFgaClient implementation; adds StreamBufferSize configuration option to ClientStreamedListObjectsOptions.
Test Updates client/streaming_test.go	Updates all streaming test cases to call the newly exported StreamedListObjects() method instead of the previous unexported variant; preserves all test logic and expectations.
Documentation CHANGELOG.md, README.md	Adds changelog entry for the StreamedListObjects feature; documents new subsection in README with usage examples, options, and behavior notes for streaming object listing without pagination limits.
Example Removal example/streamed_list_objects/main.go	Removes all example code from the streaming list objects example file, leaving only the package declaration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• chore: make streamed list objects client methods private #264: Modifies the same StreamedListObjects and StreamedListObjectsExecute client methods in the opposite direction, changing them to private unexported names.
• feat: streamed list objects endpoint  #252: Introduces the same StreamedListObjects streaming endpoint, client methods, streaming types, and model definitions.
• fix: lint fixes, sync with generator, use common streaming interface for streamed list objects #259: Modifies the streamed list objects implementation and related streaming tests for the same client API.

Suggested reviewers

• sergiught
• curfew-marathon
• ewanharris

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately reflects the main change: making previously private streamed list objects client methods public by reverting a prior privatization change.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

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.}

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 33.59%. Comparing base (7191445) to head (b7ad623).

❌ Your project status has failed because the head coverage (33.59%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #271   +/-   ##
=======================================
  Coverage   33.59%   33.59%           
=======================================
  Files         115      115           
  Lines        9810     9810           
=======================================
  Hits         3296     3296           
  Misses       6252     6252           
  Partials      262      262           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[dosubot]

Related Documentation

Checked 6 published document(s) in 0 knowledge base(s). No updates required.

^{How did I do? Any feedback?}  

[Copilot]

Pull request overview

This PR makes the StreamedListObjects API methods public by reverting a previous change that made them private. The change enables users to access the streaming variant of the ListObjects endpoint, which is particularly useful for handling large result sets from computed relations without pagination limits.

Key changes:

• Made StreamedListObjects and StreamedListObjectsExecute methods public in the client interface and implementation
• Updated all test references from lowercase streamedListObjects to uppercase StreamedListObjects
• Re-enabled the example code demonstrating the StreamedListObjects functionality
• Added comprehensive documentation to the README with usage examples

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
client/client.go	Made StreamedListObjects and StreamedListObjectsExecute methods public by capitalizing them; added them to the SdkClient interface
client/streaming_test.go	Updated all test method calls from streamedListObjects to StreamedListObjects to use the newly public method
example/streamed_list_objects/main.go	Uncommented the complete working example code that demonstrates StreamedListObjects usage
README.md	Added "Streamed List Objects" section with comprehensive documentation, code example, and explanation of key differences from standard ListObjects
CHANGELOG.md	Added changelog entry for StreamedListObjects endpoint support

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Siddhant-K-code]

Changes overall look good. Do we have an open issue for this?

[SoulPancake]

@Siddhant-K-code Just as a part of the overall issue of making streamed list objects available for public use

Parent issue : openfga/sdk-generator#76