fix: OpenFGA SDK doesn't seem to support async_req parameter

[Abishek-Newar]

Description

What problem is being solved?

The async_req parameter exists in the lower-level api_client.py to enable threading-based asynchronous requests using Python's ThreadPool. However, this parameter is not exposed through the public OpenFgaClient API because the options_to_kwargs function doesn't support it, making it inaccessible without using internal APIs.

How is it being solved?

Updated the options_to_kwargs function to pass through the async_req parameter from user options to the underlying API calls.

What changes are made to solve it?

• Added async_req parameter support in openfga_sdk/sync/client/client.py (sync client)

After this change, users can use async_req like this:

result = client.list_stores(options={"async_req": True})

References

closes #194

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
• 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 asynchronous request handling in API client operations. Users can now pass async request preferences through configuration options to enable non-blocking API calls.

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

[dosubot]

Related Documentation

Checked 5 published document(s) in 1 knowledge base(s). No updates required.

^{How did I do? Any feedback?}  

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

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 55aed599-1891-45e7-846a-e4892d6e9f89

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

Adds support for passing the async_req parameter through the options mapping in both sync and async client implementations, allowing users to control async request behavior via the public API instead of internal APIs.

Changes

Cohort / File(s)	Summary
Async Request Parameter Support openfga_sdk/client/client.py, openfga_sdk/sync/client/client.py	Extends options_to_kwargs function to propagate async_req from options dictionary to kwargs, enabling async request signaling through public API calls. Identical change applied to both client implementations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding support for the async_req parameter in the OpenFGA SDK.
Linked Issues check	✅ Passed	The PR directly addresses all requirements from issue #194 by adding async_req parameter support to options_to_kwargs in both client implementations, enabling public API usage.
Out of Scope Changes check	✅ Passed	All changes are directly related to exposing the async_req parameter through the public API, with no unrelated modifications to the codebase.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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 unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

📝 Coding Plan

• Generate coding plan for human review comments

---

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

Tip

You can validate your CodeRabbit configuration file in your editor.

If your editor has YAML language server, you can enable auto-completion and validation by adding # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json at the top of your CodeRabbit configuration file.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.36%. Comparing base (4f89e71) to head (4d40ab1).

❌ Your project status has failed because the head coverage (71.36%) 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     #253      +/-   ##
==========================================
+ Coverage   71.17%   71.36%   +0.19%     
==========================================
  Files         137      137              
  Lines       11100    11104       +4     
==========================================
+ Hits         7900     7924      +24     
+ Misses       3200     3180      -20     

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

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@openfga_sdk/client/client.py`:
- Around line 123-124: Reject the async_req option in the async client path:
locate the code that checks options.get("async_req") and currently sets
kwargs["async_req"], and change it to raise a clear ValueError (or TypeError)
when options["async_req"] is not None, explaining that async_req is incompatible
with the async client (it triggers self.pool.apply_async and returns a
non-awaitable). Ensure the error message references async_req and the async
client so callers get an explicit, actionable failure instead of a silent
runtime error.

[SoulPancake]

I see that it initially was added to the async client too

Please update the PR description - Remove the line about async client changes since you've already removed that code

You checked "I have added tests" but there are currently no test files are in the diff

[Abishek-Newar]

hi @SoulPancake , done

[SoulPancake]

Hi @Abishek-Newar
What I meant was, you need to add tests to assert this change
Not remove it from the description, I hope that helps 😅

[Abishek-Newar]

@SoulPancake , Sorry, my bad 😅
I will make the changes

[Copilot]

Pull request overview

This PR aims to expose the underlying OpenAPI-generated async_req threading option via the public client options, by passing it through options_to_kwargs to the generated API methods.

Changes:

• Add passthrough support for options["async_req"] in the sync client’s options_to_kwargs.

---

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