release: v0.9.7 (#234)

evansims · web-flow · commit 6f06c2fb7c64 · 2025-10-06T20:19:44.000Z
* release: v0.9.7

* docs: update socket badge
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,13 @@
 # Changelog
 
-## [Unreleased](https://github.com/openfga/python-sdk/compare/v0.9.6...HEAD)
+## [Unreleased](https://github.com/openfga/python-sdk/compare/v0.9.7...HEAD)
 
-### [0.9.6](https://github.com/openfga/python-sdk/compare/v0.9.5...0.9.6) (2025-09-15)
+### [0.9.7](https://github.com/openfga/python-sdk/compare/v0.9.6...0.9.7) (2025-10-06)
+
+- feat: `headers` configuration property (#233)
+- fix: per-request custom header precedence (#230)
+
+### [v0.9.6](https://github.com/openfga/python-sdk/compare/v0.9.5...v0.9.6) (2025-09-15)
 
 - fix: reuse ssl context in the sync client (#222) - thanks @wadells!
 - feat: add OAuth2 scopes parameter support to CredentialConfiguration (#213) - thanks @SoulPancake
diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 # Python SDK for OpenFGA
 
 [![pypi](https://img.shields.io/pypi/v/openfga_sdk.svg?style=flat)](https://pypi.org/project/openfga_sdk)
-[![Socket Badge](https://badge.socket.dev/pypi/package/openfga-sdk/0.9.6)](https://socket.dev/pypi/package/openfga-sdk)
-[![DeepWiki](https://img.shields.io/badge/DeepWiki-openfga%2Fpython--sdk-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/openfga/python-sdk)[![Release](https://img.shields.io/github/v/release/openfga/python-sdk?sort=semver&color=green)](https://github.com/openfga/python-sdk/releases)
+[![Socket Badge](https://badge.socket.dev/pypi/package/openfga-sdk/0.9.7](https://socket.dev/pypi/package/openfga-sdk)
+[![DeepWiki](https://img.shields.io/badge/DeepWiki-openfga%2Fpython--sdk-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/openfga/python-sdk)
+[![Release](https://img.shields.io/github/v/release/openfga/python-sdk?sort=semver&color=green)](https://github.com/openfga/python-sdk/releases)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenfga%2Fpython-sdk.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenfga%2Fpython-sdk?ref=badge_shield)
 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/openfga/python-sdk/badge)](https://securityscorecards.dev/viewer/?uri=github.com/openfga/python-sdk)
 [![Join our community](https://img.shields.io/badge/slack-cncf_%23openfga-40abb8.svg?logo=slack)](https://openfga.dev/community)
diff --git a/VERSION.txt b/VERSION.txt
@@ -1 +1 @@
-0.9.6
+0.9.7
diff --git a/example/example1/requirements.txt b/example/example1/requirements.txt
@@ -4,7 +4,7 @@ attrs >= 25.3.0
 frozenlist >= 1.7.0
 idna >= 3.10
 multidict >= 6.6.4
-openfga-sdk >= 0.9.6
+openfga-sdk >= 0.9.7
 python-dateutil >= 2.9.0.post0
 urllib3 >= 1.26.19, != 2.0.*, != 2.1.*, != 2.2.0, != 2.2.1, < 3
 yarl >= 1.20.1
diff --git a/example/example1/setup.py b/example/example1/setup.py
@@ -15,7 +15,7 @@
 
 NAME = "example1"
 VERSION = "0.0.1"
-REQUIRES = ["openfga-sdk >= 0.9.6"]
+REQUIRES = ["openfga-sdk >= 0.9.7"]
 
 setup(
     name=NAME,
diff --git a/openfga_sdk/__init__.py b/openfga_sdk/__init__.py
@@ -10,7 +10,7 @@
 NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
 """
 
-__version__ = "0.9.6"
+__version__ = "0.9.7"
 
 from openfga_sdk.api.open_fga_api import OpenFgaApi
 from openfga_sdk.api_client import ApiClient
diff --git a/openfga_sdk/api_client.py b/openfga_sdk/api_client.py
@@ -39,7 +39,7 @@
 from openfga_sdk.telemetry.attributes import TelemetryAttribute, TelemetryAttributes
 
 
-DEFAULT_USER_AGENT = "openfga-sdk python/0.9.6"
+DEFAULT_USER_AGENT = "openfga-sdk python/0.9.7"
 
 
 def random_time(loop_count, min_wait_in_ms) -> float:
diff --git a/openfga_sdk/configuration.py b/openfga_sdk/configuration.py
@@ -543,7 +543,7 @@ def to_debug_report(self):
             f"OS: {sys.platform}\n"
             f"Python Version: {sys.version}\n"
             "Version of the API: 1.x\n"
-            "SDK Package Version: 0.9.6"
+            "SDK Package Version: 0.9.7"
         )
 
     def get_host_settings(self):
diff --git a/openfga_sdk/oauth2.py b/openfga_sdk/oauth2.py
@@ -90,7 +90,7 @@ async def _obtain_token(self, client):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
 
diff --git a/openfga_sdk/sync/api_client.py b/openfga_sdk/sync/api_client.py
@@ -38,7 +38,7 @@
 from openfga_sdk.telemetry.attributes import TelemetryAttribute, TelemetryAttributes
 
 
-DEFAULT_USER_AGENT = "openfga-sdk python/0.9.6"
+DEFAULT_USER_AGENT = "openfga-sdk python/0.9.7"
 
 
 def random_time(loop_count, min_wait_in_ms) -> float:
diff --git a/openfga_sdk/sync/oauth2.py b/openfga_sdk/sync/oauth2.py
@@ -90,7 +90,7 @@ def _obtain_token(self, client):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -10,7 +10,7 @@
 
 [project]
 name = "openfga-sdk"
-version = "0.9.6"
+version = "0.9.7"
 description="A high performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar."
 authors = [
     { name = "OpenFGA (https://openfga.dev)", email = "community@openfga.dev"}
diff --git a/test/api/open_fga_api_test.py b/test/api/open_fga_api_test.py
@@ -1782,7 +1782,7 @@ async def test_check_api_token(self, mock_request):
                 {
                     "Accept": "application/json",
                     "Content-Type": "application/json",
-                    "User-Agent": "openfga-sdk python/0.9.6",
+                    "User-Agent": "openfga-sdk python/0.9.7",
                     "Authorization": "Bearer TOKEN1",
                 }
             )
@@ -1836,7 +1836,7 @@ async def test_check_custom_header(self, mock_request):
                 {
                     "Accept": "application/json",
                     "Content-Type": "application/json",
-                    "User-Agent": "openfga-sdk python/0.9.6",
+                    "User-Agent": "openfga-sdk python/0.9.7",
                     "Custom Header": "custom value",
                 }
             )
@@ -2084,7 +2084,7 @@ async def test_check_custom_header_override_default_header(self, mock_request):
                 {
                     "Accept": "application/json",
                     "Content-Type": "application/json",
-                    "User-Agent": "openfga-sdk python/0.9.6",
+                    "User-Agent": "openfga-sdk python/0.9.7",
                     "X-Custom-Header": "per-request-value",  # Should be the per-request value
                 }
             )
@@ -2143,7 +2143,7 @@ async def test_check_per_request_header_and_default_header_coexist(
                 {
                     "Accept": "application/json",
                     "Content-Type": "application/json",
-                    "User-Agent": "openfga-sdk python/0.9.6",
+                    "User-Agent": "openfga-sdk python/0.9.7",
                     "X-Default-Header": "default-value",  # Default header preserved
                     "X-Per-Request-Header": "per-request-value",  # Per-request header added
                 }
diff --git a/test/oauth2_test.py b/test/oauth2_test.py
@@ -84,7 +84,7 @@ async def test_get_authentication_obtain_client_credentials(self, mock_request):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
@@ -310,7 +310,7 @@ async def test_get_authentication_keep_full_url(self, mock_request):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
@@ -365,7 +365,7 @@ async def test_get_authentication_add_scheme(self, mock_request):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
@@ -420,7 +420,7 @@ async def test_get_authentication_add_path(self, mock_request):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
@@ -475,7 +475,7 @@ async def test_get_authentication_add_scheme_and_path(self, mock_request):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
@@ -533,7 +533,7 @@ async def test_get_authentication_obtain_client_credentials_with_scopes_list(
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
@@ -592,7 +592,7 @@ async def test_get_authentication_obtain_client_credentials_with_scopes_string(
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
diff --git a/test/sync/oauth2_test.py b/test/sync/oauth2_test.py
@@ -84,7 +84,7 @@ def test_get_authentication_obtain_client_credentials(self, mock_request):
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
@@ -142,7 +142,7 @@ def test_get_authentication_obtain_client_credentials_with_scopes_list(
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
@@ -201,7 +201,7 @@ def test_get_authentication_obtain_client_credentials_with_scopes_string(
             {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded",
-                "User-Agent": "openfga-sdk (python) 0.9.6",
+                "User-Agent": "openfga-sdk (python) 0.9.7",
             }
         )
         mock_request.assert_called_once_with(
diff --git a/test/sync/open_fga_api_test.py b/test/sync/open_fga_api_test.py
@@ -1845,7 +1845,7 @@ def test_check_api_token(self, mock_request):
                 {
                     "Accept": "application/json",
                     "Content-Type": "application/json",
-                    "User-Agent": "openfga-sdk python/0.9.6",
+                    "User-Agent": "openfga-sdk python/0.9.7",
                     "Authorization": "Bearer TOKEN1",
                 }
             )
@@ -1899,7 +1899,7 @@ def test_check_custom_header(self, mock_request):
                 {
                     "Accept": "application/json",
                     "Content-Type": "application/json",
-                    "User-Agent": "openfga-sdk python/0.9.6",
+                    "User-Agent": "openfga-sdk python/0.9.7",
                     "Custom Header": "custom value",
                 }
             )
@@ -1956,7 +1956,7 @@ def test_check_custom_header_override_default_header(self, mock_request):
                 {
                     "Accept": "application/json",
                     "Content-Type": "application/json",
-                    "User-Agent": "openfga-sdk python/0.9.6",
+                    "User-Agent": "openfga-sdk python/0.9.7",
                     "X-Custom-Header": "per-request-value",  # Should be the per-request value
                 }
             )
@@ -2013,7 +2013,7 @@ def test_check_per_request_header_and_default_header_coexist(self, mock_request)
                 {
                     "Accept": "application/json",
                     "Content-Type": "application/json",
-                    "User-Agent": "openfga-sdk python/0.9.6",
+                    "User-Agent": "openfga-sdk python/0.9.7",
                     "X-Default-Header": "default-value",  # Default header preserved
                     "X-Per-Request-Header": "per-request-value",  # Per-request header added
                 }
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -543,7 +543,7 @@ def to_debug_report(self):`
`543`	`543`	`f"OS: {sys.platform}\n"`
`544`	`544`	`f"Python Version: {sys.version}\n"`
`545`	`545`	`"Version of the API: 1.x\n"`
`546`		`- "SDK Package Version: 0.9.6"`
	`546`	`+ "SDK Package Version: 0.9.7"`
`547`	`547`	`)`
`548`	`548`
`549`	`549`	`def get_host_settings(self):`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ async def _obtain_token(self, client):`
`90`	`90`	`{`
`91`	`91`	`"Accept": "application/json",`
`92`	`92`	`"Content-Type": "application/x-www-form-urlencoded",`
`93`		`- "User-Agent": "openfga-sdk (python) 0.9.6",`
	`93`	`+ "User-Agent": "openfga-sdk (python) 0.9.7",`
`94`	`94`	`}`
`95`	`95`	`)`
`96`	`96`