Skip to content

Version 3.1, using openapi 7.16#37

Merged
mshriver merged 1 commit into
mainfrom
openapi-gen-716
Oct 14, 2025
Merged

Version 3.1, using openapi 7.16#37
mshriver merged 1 commit into
mainfrom
openapi-gen-716

Conversation

@mshriver
Copy link
Copy Markdown
Contributor

@mshriver mshriver commented Oct 14, 2025

Summary by Sourcery

Regenerate the Python SDK using OpenAPI Generator 7.16.0 with the OpenAPI spec bumped to 2.8.1, update client version to 3.1.0, and refine deserialization type checks.

Bug Fixes:

  • Use identity comparisons ('is') for object, date, datetime, and Decimal type checks in the deserializer

Enhancements:

  • Bump OpenAPI spec version from 2.8.0 to 2.8.1 across generated code
  • Update SDK package version to 3.1.0 and adjust debug report strings

Build:

  • Upgrade OpenAPI Generator version to 7.16.0 in regenerate-client.sh

Tests:

  • Regenerate test files to reflect the updated OpenAPI spec version

Copilot AI review requested due to automatic review settings October 14, 2025 13:02
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Oct 14, 2025

Reviewer's Guide

Client regenerated with OpenAPI Generator 7.16, updating the OpenAPI document version to 2.8.1 and SDK version to 3.1.0 across all modules and tests, and improving type comparisons in the deserializer for more accurate identity checks.

Class diagram for updated deserialization logic in ApiClient

classDiagram
    class ApiClient {
        __deserialize(data, klass)
        __deserialize_primitive(data, klass)
        __deserialize_object(data)
        __deserialize_date(data)
        __deserialize_datetime(data)
        __deserialize_enum(data, klass)
    }
    ApiClient : PRIMITIVE_TYPES
    ApiClient : __deserialize now uses 'is' for type checks
    ApiClient : Handles object, datetime.date, datetime.datetime, decimal.Decimal with 'is' identity checks
Loading

File-Level Changes

Change Details Files
Improve type identity checks in the deserializer
  • Replaced '==' with 'is' for object comparison
  • Replaced '==' with 'is' for datetime.date comparison
  • Replaced '==' with 'is' for datetime.datetime comparison
  • Replaced instantiation of decimal.Decimal(data) under '==' with identity check
ibutsu_client/api_client.py
Bump OpenAPI document version and SDK package version
  • Updated OpenAPI document version from 2.8.0 to 2.8.1 in headers
  • Updated debug report to reflect API version 2.8.1 and SDK package 3.1.0
ibutsu_client/configuration.py
ibutsu_client/__init__.py
ibutsu_client/api/admin_project_management_api.py
ibutsu_client/api/admin_user_management_api.py
ibutsu_client/api/artifact_api.py
ibutsu_client/api/dashboard_api.py
ibutsu_client/api/group_api.py
ibutsu_client/api/health_api.py
ibutsu_client/api/import_api.py
ibutsu_client/api/login_api.py
ibutsu_client/api/project_api.py
ibutsu_client/api/result_api.py
ibutsu_client/api/run_api.py
ibutsu_client/api/task_api.py
ibutsu_client/api/user_api.py
ibutsu_client/api/widget_api.py
ibutsu_client/api/widget_config_api.py
ibutsu_client/exceptions.py
ibutsu_client/models/account_recovery.py
ibutsu_client/models/account_registration.py
ibutsu_client/models/account_reset.py
ibutsu_client/models/artifact.py
ibutsu_client/models/artifact_list.py
ibutsu_client/models/create_token.py
ibutsu_client/models/credentials.py
ibutsu_client/models/dashboard.py
ibutsu_client/models/dashboard_list.py
ibutsu_client/models/group.py
ibutsu_client/models/group_list.py
ibutsu_client/models/health.py
ibutsu_client/models/health_info.py
ibutsu_client/models/login_config.py
ibutsu_client/models/login_error.py
ibutsu_client/models/login_support.py
ibutsu_client/models/login_token.py
ibutsu_client/models/model_import.py
ibutsu_client/models/pagination.py
ibutsu_client/models/project.py
ibutsu_client/models/project_list.py
ibutsu_client/models/result.py
ibutsu_client/models/result_list.py
ibutsu_client/models/run.py
ibutsu_client/models/run_list.py
ibutsu_client/models/token.py
ibutsu_client/models/token_list.py
ibutsu_client/models/update_run.py
ibutsu_client/models/user.py
ibutsu_client/models/user_list.py
ibutsu_client/models/widget_config.py
ibutsu_client/models/widget_config_list.py
ibutsu_client/models/widget_param.py
ibutsu_client/models/widget_type.py
ibutsu_client/models/widget_type_list.py
ibutsu_client/rest.py
test/test_account_recovery.py
test/test_account_registration.py
test/test_account_reset.py
test/test_admin_project_management_api.py
test/test_admin_user_management_api.py
test/test_artifact.py
test/test_artifact_api.py
test/test_artifact_list.py
test/test_create_token.py
test/test_credentials.py
test/test_dashboard.py
test/test_dashboard_api.py
test/test_dashboard_list.py
test/test_group.py
test/test_group_api.py
test/test_group_list.py
test/test_health.py
test/test_health_api.py
test/test_health_info.py
test/test_import_api.py
test/test_login_api.py
test/test_login_config.py
test/test_login_error.py
test/test_login_support.py
test/test_login_token.py
test/test_model_import.py
test/test_pagination.py
test/test_project.py
test/test_project_api.py
test/test_project_list.py
test/test_result.py
test/test_result_api.py
test/test_result_list.py
test/test_run.py
test/test_run_api.py
test/test_run_list.py
test/test_task_api.py
test/test_token.py
test/test_token_list.py
test/test_update_run.py
test/test_user.py
test/test_user_api.py
test/test_user_list.py
test/test_widget_api.py
test/test_widget_config.py
test/test_widget_config_api.py
test/test_widget_config_list.py
test/test_widget_param.py
test/test_widget_type.py
test/test_widget_type_list.py
Update OpenAPI Generator version
  • Bumped OPENAPI_GENERATOR_VERSION to 7.16.0 in regeneration script
regenerate-client.sh

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the OpenAPI-generated Python client from version 2.8.0 to 2.8.1, regenerated using OpenAPI Generator 7.16.0 (up from 7.15.0). The changes include version string updates across all generated files, removal of lazy import infrastructure, and minor code style improvements in deserialization logic.

Reviewed Changes

Copilot reviewed 108 out of 108 changed files in this pull request and generated no comments.

Show a summary per file
File Description
regenerate-client.sh Updates OpenAPI Generator version to 7.16.0
ibutsu_client/configuration.py Updates API version string to 2.8.1
ibutsu_client/api_client.py Updates version and improves equality checks using is operator
ibutsu_client/init.py Removes lazy import conditional logic, simplifies imports
ibutsu_client/api/init.py Removes lazy import infrastructure
ibutsu_client/models/init.py Removes lazy import infrastructure
All other files Updates OpenAPI document version comment from 2.8.0 to 2.8.1

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `ibutsu_client/api_client.py:430-431` </location>
<code_context>
-        elif klass == object:
+        elif klass is object:
             return self.__deserialize_object(data)
-        elif klass == datetime.date:
+        elif klass is datetime.date:
             return self.__deserialize_date(data)
-        elif klass == datetime.datetime:
</code_context>

<issue_to_address>
**suggestion:** Changed type comparison to 'is' for datetime.date, which is more robust.

If 'klass' might be a subclass of 'datetime.date', 'is' will not match; ensure subclassing is not expected.

```suggestion
        elif klass == datetime.date:
            return self.__deserialize_date(data)
```
</issue_to_address>

### Comment 2
<location> `ibutsu_client/api_client.py:432-433` </location>
<code_context>
-        elif klass == datetime.date:
+        elif klass is datetime.date:
             return self.__deserialize_date(data)
-        elif klass == datetime.datetime:
+        elif klass is datetime.datetime:
             return self.__deserialize_datetime(data)
-        elif klass == decimal.Decimal:
</code_context>

<issue_to_address>
**suggestion:** Type comparison for datetime.datetime now uses 'is', which is more idiomatic.

If you need to support subclasses of datetime.datetime, use 'issubclass' for broader compatibility.

```suggestion
        elif isinstance(klass, type) and issubclass(klass, datetime.datetime):
            return self.__deserialize_datetime(data)
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread ibutsu_client/api_client.py
Comment thread ibutsu_client/api_client.py
@mshriver mshriver merged commit b45453b into main Oct 14, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants