Home Original page

release: v0.9.5 by evansims · Pull Request #200 · openfga/python-sdk

Walkthrough

This update increments the SDK version from 0.9.4 to 0.9.5 across all relevant files and documentation. It includes a bug fix ensuring that the response body from aiohttp.ClientResponse is read and attached before error handling. Documentation, changelog, and test cases are updated to reflect the new version and clarify batch check API behavior.

Changes

Files/Paths Change Summary
.openapi-generator/FILES Reordered and regrouped manifest entries; no content changes.
CHANGELOG.md, VERSION.txt, setup.py, openfga_sdk/init.py Bumped version from 0.9.4 to 0.9.5 in changelog, version file, setup, and SDK.
README.md, docs/OpenFgaApi.md Clarified batch check result ordering and reformatted Read API documentation.
openfga_sdk/api/open_fga_api.py, openfga_sdk/sync/open_fga_api.py Updated docstrings for Read API methods for clarity; no logic changes.
openfga_sdk/api_client.py, openfga_sdk/sync/api_client.py Updated DEFAULT_USER_AGENT version string to 0.9.5.
openfga_sdk/oauth2.py, openfga_sdk/sync/oauth2.py Updated "User-Agent" header version string to 0.9.5 in OAuth2 token requests.
openfga_sdk/configuration.py Updated SDK version string in debug report to 0.9.5.
openfga_sdk/rest.py Bug fix: Ensure aiohttp.ClientResponse body is read and attached as data before error handling.
example/example1/requirements.txt, example/example1/setup.py Updated minimum SDK dependency to >= 0.9.5.
test/api/open_fga_api_test.py, test/sync/open_fga_api_test.py, test/oauth2_test.py, Updated "User-Agent" header version in test assertions to 0.9.5.
test/sync/oauth2_test.py Updated "User-Agent" header version in test assertion to 0.9.5.
test/rest_test.py Added async test verifying handle_response_exception reads and attaches response data for error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RESTClientObject
    participant aiohttp.ClientResponse

    Client->>RESTClientObject: handle_response_exception(response)
    alt response is aiohttp.ClientResponse and lacks data
        RESTClientObject->>aiohttp.ClientResponse: await read()
        aiohttp.ClientResponse-->>RESTClientObject: body bytes
        RESTClientObject->>aiohttp.ClientResponse: set data attribute
    end
    RESTClientObject->>Client: Raise appropriate exception with response data
Loading

Possibly related PRs

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.