Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #261 +/- ##
=======================================
Coverage 69.84% 69.84%
=======================================
Files 140 140
Lines 10743 10743
=======================================
Hits 7503 7503
Misses 3240 3240 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR prepares the openfga-sdk Python package for the v0.10.0 release by updating version references across packaging metadata, runtime constants, examples, and release documentation.
Changes:
- Bump SDK/package version from
0.9.9to0.10.0across project metadata and runtime constants. - Update example dependencies to require
openfga-sdk >= 0.10.0. - Update release documentation (CHANGELOG + README badge) to reflect
v0.10.0.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
uv.lock |
Updates locked editable package version to 0.10.0. |
pyproject.toml |
Bumps project version to 0.10.0 for packaging/release. |
openfga_sdk/constants.py |
Updates SDK_VERSION and USER_AGENT to 0.10.0. |
example/example1/setup.py |
Raises example’s SDK dependency floor to >= 0.10.0. |
example/example1/requirements.txt |
Raises example’s SDK dependency floor to >= 0.10.0. |
VERSION.txt |
Updates repo version marker to 0.10.0. |
README.md |
Updates Socket badge URL to the 0.10.0 version. |
CHANGELOG.md |
Updates Unreleased comparison link and adds 0.10.0 release section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Documentation Updates 1 document(s) were updated by changes in this PR: Retry-After Header and Retry StrategyView Changes@@ -136,7 +136,7 @@
---
### Python SDK
-**Version Introduced:** v0.9.4 (2025-04-30)
+**Version Introduced:** v0.9.4 (Current version: v0.10.0)
**[Changelog](https://github.com/openfga/python-sdk/pull/189)**
#### Retry-After Handling
@@ -161,10 +161,18 @@
#### Error Exposure
If the `Retry-After` header is invalid or missing, a `ValueError` is raised and the SDK falls back to exponential backoff. Retry-related errors are surfaced through exceptions.
+#### New Methods in v0.10.0
+The SDK adds `execute_api_request` and `execute_streamed_api_request` methods to `OpenFgaClient` and `OpenFgaApi` for making arbitrary HTTP requests to any OpenFGA API endpoint with full auth, retry, and telemetry support. These methods are the recommended approach for users who need access to raw HTTP response details.
+
#### Migration Guidance
- The default `max_retry` is now 3 (was previously 15).
- Ensure any custom retry logic or error handling is updated to use the new configuration and error exposure patterns.
-- Upgrade to v0.9.4+ for full `Retry-After` support.
+- Upgrade to v0.10.0+ for full `Retry-After` support and the latest features.
+
+##### Breaking Changes in v0.10.0
+- The `_return_http_data_only`, `_preload_content`, `_request_auth`, `async_req`, and `_request_timeout` kwargs have been removed from all `OpenFgaApi` and `SyncOpenFgaApi` endpoint methods. These were internal implementation details not intended for external use.
+- `_return_http_data_only` is now hardcoded to `True`; all endpoint methods return the deserialized response object directly.
+- Users previously relying on `_with_http_info` methods returning a `(data, status, headers)` tuple should use the new `execute_api_request` method instead.
---
|
rhamzeh
left a comment
There was a problem hiding this comment.
FYI Snyk is failing b/c example 1 uses openfga-sdk >= 0.10.0, which hasn't been published yet - so not an issue, this release will publish it.
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
main