chore: sync sdk generator changes by rhamzeh · Pull Request #221 · openfga/python-sdk
Walkthrough
Updates the generator manifest, reorganizes docs and examples, adds/clarifies API method docstrings, and adjusts tests (formatting, one async→sync change, added client cleanup). No functional SDK code changes; primarily documentation and manifest exposure of additional model modules and example scaffolding.
Changes
| Cohort / File(s) | Change summary |
|---|---|
Generator manifest and exposure\.openapi-generator/FILES |
Refreshed file manifest: added LICENSE/README/VERSION, new docs and examples, exposed new model modules (e.g., condition, usersets, tuple variants), added openfga_sdk/api_client.py, and test package init files. Reordered/expanded public entries. |
Docs and READMEREADME.md, docs/OpenFgaApi.md |
Clarified Batch Check behavior/limits and retry notes; added constraint for read tuple_key.user requiring full object. Wording and structure updates only. |
API docstrings (async and sync)openfga_sdk/api/open_fga_api.py, openfga_sdk/sync/open_fga_api.py |
Augmented docstrings for batch_check and read methods: environment variable for max batch size, SDK auto-splitting, and read input constraint. No logic changes. |
Tests (async/sync, formatting, cleanup)test/oauth2_test.py, test/sync/oauth2_test.py |
Reformatted function signatures across lines; converted one test from async to sync in sync suite; added rest_client.close() cleanup in one test. No core logic changes. |
Estimated code review effort
🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
- release: v0.9.5 #200 — Touches the same OpenFGA API docstrings (read/batch_check) and updates the .openapi-generator/FILES manifest, indicating parallel documentation and manifest alignment.
Pre-merge checks (3 passed)
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title Check | ✅ Passed | The title "chore: sync sdk generator changes" accurately describes the primary intent of the changeset — synchronizing generator-produced SDK artifacts (manifest updates, added/updated models, API client entries, docs and examples) — and is concise and clear for repository history. It uses a standard "chore:" prefix and directly relates to the main changes described in the PR. |
| Docstring Coverage | ✅ Passed | Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. |
✨ Finishing touches
- 📝 Generate Docstrings
🧪 Generate unit tests
- Create PR with unit tests
- Post copyable unit tests in a comment
- Commit unit tests in branch
chore/sync-sdk-generator-changes
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 @coderabbitai help to get the list of available commands and usage tips.