fix: update Python docs to match SDK#763
Open
Koosha-Owji wants to merge 1 commit into
Open
Conversation
Contributor
WalkthroughThe Python SDK documentation now reflects v2+ architecture, including new exception modules, synchronous ManagementClient construction, revised Management API examples, updated permission checks, and FastAPI handling for Management API exceptions. ChangesPython SDK v2 guidance
Estimated code review effort: 3 (Moderate) | ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Deploying kinde-docs-preview with
|
| Latest commit: |
d49c202
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4dad3a4a.kinde-docs-preview.pages.dev |
| Branch Preview URL: | https://fix-python-sdk-management-do.kinde-docs-preview.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/developer-tools/sdks/backend/python-sdk.mdx`:
- Around line 1505-1520: Update both FastAPI route examples, including
list_organizations and the corresponding route around the second
ManagementClient example, so synchronous management API calls do not run
directly inside async handlers. Prefer changing each route declaration from
async def to def, preserving the existing synchronous management calls and
response behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 072a4a3c-ae2c-4718-a893-c800c25b4507
📒 Files selected for processing (1)
src/content/docs/developer-tools/sdks/backend/python-sdk.mdx
Comment on lines
1505
to
1520
| ```python | ||
| from kinde_sdk.auth.async_oauth import AsyncOAuth | ||
| from fastapi import FastAPI | ||
| from kinde_sdk.management import ManagementClient | ||
|
|
||
| oauth = AsyncOAuth() | ||
| app = FastAPI() | ||
| management = ManagementClient( | ||
| domain="your-domain.kinde.com", | ||
| client_id="your-m2m-client-id", | ||
| client_secret="your-m2m-client-secret", | ||
| ) | ||
|
|
||
| async def manage_organizations(): | ||
| # Get management client | ||
| management = await oauth.get_management() | ||
|
|
||
| # List organizations | ||
| orgs = await management.get_organizations() | ||
|
|
||
| # Get a specific organization | ||
| org = await management.get_organization(org_id="org_123") | ||
|
|
||
| # Create a new organization | ||
| new_org = await management.create_organization( | ||
| name="My Organization" | ||
| ) | ||
|
|
||
| # Update an organization | ||
| updated_org = await management.update_organization( | ||
| org_id="org_123", | ||
| name="Updated Name" | ||
| ) | ||
|
|
||
| # Delete an organization | ||
| await management.delete_organization(org_id="org_123") | ||
|
|
||
| return orgs | ||
| @app.get("/organizations") | ||
| async def list_organizations(): | ||
| # The management call itself is synchronous | ||
| return management.organizations_api.get_organizations() | ||
| ``` |
Contributor
There was a problem hiding this comment.
🩺 Stability & Availability | 🟠 Major | ⚡ Quick win
Synchronous ManagementClient calls in async FastAPI routes block the event loop.
Both examples define async def routes but call synchronous management.* methods directly. This blocks the event loop for the duration of each HTTP call to Kinde's API, starving concurrent requests. The comment on line 1518 acknowledges the call is synchronous but doesn't address the blocking consequence.
Either define the route as a regular def (FastAPI automatically runs sync routes in a threadpool) or offload the call with asyncio.to_thread():
⚡ Proposed fix — use `def` instead of `async def` (simplest)
`@app.get`("/organizations")
-async def list_organizations():
+def list_organizations():
# The management call itself is synchronous
return management.organizations_api.get_organizations() `@app.get`("/users/{user_id}")
-async def get_user(user_id: str):
+def get_user(user_id: str):
try:
return management.users_api.get_user_data(id=user_id)
except NotFoundException:
raise HTTPException(status_code=404, detail="User not found")
except ApiException as e:
raise HTTPException(status_code=e.status, detail=e.reason)Alternatively, if the route must stay async:
⚡ Alternative fix — offload with `asyncio.to_thread`
`@app.get`("/organizations")
async def list_organizations():
- # The management call itself is synchronous
- return management.organizations_api.get_organizations()
+ return await asyncio.to_thread(management.organizations_api.get_organizations)Also applies to: 1538-1546
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/content/docs/developer-tools/sdks/backend/python-sdk.mdx` around lines
1505 - 1520, Update both FastAPI route examples, including list_organizations
and the corresponding route around the second ManagementClient example, so
synchronous management API calls do not run directly inside async handlers.
Prefer changing each route declaration from async def to def, preserving the
existing synchronous management calls and response behavior.
KomanRudden
approved these changes
Jul 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description (required)
Fixes the Python SDK docs to match the SDK.
All code samples checked against the current SDK.
Related issues & labels (optional)
Summary by CodeRabbit