Skip to content

feat(go-sdk) : reverse sync auxiliary changes for go streamed list objects endpoint#661

Merged
SoulPancake merged 3 commits intomainfrom
feat/go-sdk/reverse-sync-go-sdk
Nov 19, 2025
Merged

feat(go-sdk) : reverse sync auxiliary changes for go streamed list objects endpoint#661
SoulPancake merged 3 commits intomainfrom
feat/go-sdk/reverse-sync-go-sdk

Conversation

@SoulPancake
Copy link
Copy Markdown
Member

@SoulPancake SoulPancake commented Nov 19, 2025

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

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

  • New Features

    • Added support for Streamed ListObjects API, enabling unlimited streaming of results without traditional 1000-item pagination constraints.
  • Documentation

    • Added new documentation with usage examples for the Streamed ListObjects API, covering streaming request patterns, result consumption, and error handling.

Copilot AI review requested due to automatic review settings November 19, 2025 17:15
@SoulPancake SoulPancake requested a review from a team as a code owner November 19, 2025 17:15
@coderabbitai
Copy link
Copy Markdown
Contributor

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

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Adds configuration flag "supportsStreamedListObjects" to the Go SDK configuration overrides and introduces documentation for the new streamed ListObjects API in the README template, enabling streaming of list objects without the 1000-item pagination limit.

Changes

Cohort / File(s) Change Summary
Go SDK Configuration
config/clients/go/config.overrides.json
Adds new top-level JSON field supportsStreamedListObjects with value "streamed_list_objects" for feature flagging.
Go SDK Documentation
config/clients/go/template/README_calling_api.mustache
Introduces documentation section for Streamed ListObjects API, including usage example with options, request body, streaming response consumption, and error handling; mirrors existing ListObjects documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5-10 minutes

  • Configuration field addition is straightforward with no validation or side effects to consider
  • Documentation section follows existing patterns and is largely descriptive content

Possibly related PRs

Suggested reviewers

  • rhamzeh
  • ttrzeng

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately describes the main changes: adding configuration for a streamed ListObjects feature and documentation for the Go SDK. It is specific, concise, and clearly relates to the changeset.

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.

rhamzeh
rhamzeh previously approved these changes Nov 19, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds documentation and configuration to support the Streamed List Objects endpoint in the Go SDK generator. The changes enable the SDK generator to produce documentation for the streaming variant of the ListObjects API, which returns results incrementally without pagination limits.

Key changes:

  • Adds comprehensive documentation for the StreamedListObjects API in the Go SDK template
  • Adds the supportsStreamedListObjects configuration flag to enable TOC entry in generated README

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
config/clients/go/template/README_calling_api.mustache Adds documentation section explaining StreamedListObjects API usage with code examples
config/clients/go/config.overrides.json Adds configuration flag to enable StreamedListObjects TOC entry in common README template

@SoulPancake SoulPancake changed the title feat(go-sdk) : reverse sync auxilliary changes for go streamed list objects endpoint feat(go-sdk) : reverse sync auxiliary changes for go streamed list objects endpoint Nov 19, 2025
@SoulPancake SoulPancake added this pull request to the merge queue Nov 19, 2025
Merged via the queue into main with commit 7d4a528 Nov 19, 2025
10 of 15 checks passed
@SoulPancake SoulPancake deleted the feat/go-sdk/reverse-sync-go-sdk branch November 19, 2025 18:36
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.

3 participants