Skip to content

Generate after removing report builder from spec#36

Merged
mshriver merged 1 commit into
mainfrom
drop-report-280
Oct 14, 2025
Merged

Generate after removing report builder from spec#36
mshriver merged 1 commit into
mainfrom
drop-report-280

Conversation

@mshriver
Copy link
Copy Markdown
Contributor

@mshriver mshriver commented Oct 14, 2025

Summary by Sourcery

Regenerate the Python SDK after removing report builder support, update the OpenAPI spec to v2.8.0 and bump the client version to v3.1.0, and adjust linting configuration for Pydantic validators.

Enhancements:

  • Bump OpenAPI document version to 2.8.0 and SDK package version to 3.1.0

Chores:

  • Remove report builder API, models, tests, and documentation
  • Regenerate client code to reflect spec changes
  • Add Flake8 ignore rule N805 for Pydantic validator naming

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

sourcery-ai Bot commented Oct 14, 2025

Reviewer's Guide

This PR regenerates the Python client after removing the report builder specification, updating the OpenAPI and SDK versions across the codebase, pruning all report-related APIs, models, tests, and docs, and applying a few manual fixes to lint configuration and Pydantic validation.

Class diagram for removed report-related models and APIs

classDiagram
class ReportApi
class Report
class ReportList
class ReportParameters
class GetReportTypes200ResponseInner

ReportApi --|> Report
ReportApi --|> ReportList
ReportApi --|> ReportParameters
ReportApi --|> GetReportTypes200ResponseInner
Loading

Class diagram for updated Result model validator

classDiagram
class Result {
  +result_validate_enum(value)
}
Loading

File-Level Changes

Change Details Files
Bump OpenAPI document and SDK package versions throughout the generated code
  • Updated API spec version strings from 2.7.4 to 2.8.0
  • Updated SDK version and package version from 3.0.0 to 3.1.0
  • Updated default user agent in ApiClient to reflect new SDK version
  • Updated debug report output to show new API and SDK versions
ibutsu_client/__init__.py
ibutsu_client/configuration.py
ibutsu_client/api_client.py
ibutsu_client/rest.py
ibutsu_client/models/**/*
ibutsu_client/api/**/*
ibutsu_client/exceptions.py
test/**/*
Remove Report API and model artifacts
  • Deleted ReportApi endpoints and related models in generated code
  • Removed report exports from package init.py files
  • Deleted report-related documentation and all corresponding tests
docs/GetReportTypes200ResponseInner.md
docs/Report.md
docs/ReportApi.md
docs/ReportList.md
docs/ReportParameters.md
ibutsu_client/api/report_api.py
ibutsu_client/models/get_report_types200_response_inner.py
ibutsu_client/models/report.py
ibutsu_client/models/report_list.py
ibutsu_client/models/report_parameters.py
test/test_get_report_types200_response_inner.py
test/test_report*.py
Update lint rules in project configuration
  • Added N805 to the pyproject.toml ignore list to accommodate Pydantic validator signature
pyproject.toml
Fix Pydantic field validator signature
  • Removed redundant @classmethod decorator on the result enum validator
ibutsu_client/models/result.py

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 regenerates OpenAPI client code after removing the report builder functionality from the API specification, updating the version from 2.7.4 to 2.8.0. The changes reflect the removal of report-related APIs and models while updating version references throughout the codebase.

  • Remove all report-related API endpoints, models, and documentation
  • Update OpenAPI version from 2.7.4 to 2.8.0 and SDK version from 3.0.0 to 3.1.0
  • Remove missing @classmethod decorator from Pydantic field validator

Reviewed Changes

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

Show a summary per file
File Description
Multiple test files Updated OpenAPI version reference in generated test headers
pyproject.toml Added N805 lint rule ignore for Pydantic validators using cls parameter
ibutsu_client/models/result.py Removed missing @classmethod decorator from field validator
Report-related files Complete removal of report API, models, tests, and documentation
Version files Updated API version to 2.8.0 and SDK version to 3.1.0

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 - here's some feedback:

  • Ensure the SDK version bump in version is also reflected in your packaging metadata (e.g. pyproject.toml) to avoid mismatches during releases.
  • Review any consumer code or documentation that relied on the removed ReportApi and related report models to update or remove those references.
  • Verify that dropping the @classmethod decorator on the result_validate_enum validator works as intended with your target Pydantic version and still executes the validation logic.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Ensure the SDK version bump in __version__ is also reflected in your packaging metadata (e.g. pyproject.toml) to avoid mismatches during releases.
- Review any consumer code or documentation that relied on the removed ReportApi and related report models to update or remove those references.
- Verify that dropping the @classmethod decorator on the result_validate_enum validator works as intended with your target Pydantic version and still executes the validation logic.

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.

@mshriver mshriver merged commit a879607 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