-
Notifications
You must be signed in to change notification settings - Fork 1
Update OpenAPI spec to latest version and regenerate client #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
codegen-sh
wants to merge
4
commits into
develop
Choose a base branch
from
codegen-bot/regenerate-client
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
dc43b22
Regenerate client using OpenAPI Generator 7.12.0
codegen-sh[bot] ca13414
Update OpenAPI spec to latest version and regenerate client
codegen-sh[bot] b92b147
Restore UV package manager in GitHub workflow
codegen-sh[bot] 82c9fd1
Fix build configuration for GitHub Actions workflow
codegen-sh[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,60 @@ | ||
| # codegen-api-client | ||
| API for application developers | ||
|
|
||
| ## Regenerating the Client | ||
|
|
||
| This client is automatically generated from the OpenAPI specification. To regenerate the client: | ||
|
|
||
| ### Using Docker (Recommended) | ||
|
|
||
| ```bash | ||
| # Pull the OpenAPI Generator Docker image (version 7.12.0 to match current) | ||
| docker pull openapitools/openapi-generator-cli:v7.12.0 | ||
|
|
||
| # Run the generator (from the repository root) | ||
| docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v7.12.0 generate \ | ||
| -i /local/gen/openapi.yaml \ | ||
| -g python \ | ||
| -c /local/gen/config.json \ | ||
| -o /local | ||
| ``` | ||
|
|
||
| ### Alternative: Using NPM | ||
|
|
||
| ```bash | ||
| # Install via npm | ||
| npm install -g @openapitools/[email protected] | ||
|
|
||
| # Set the version | ||
| npx @openapitools/openapi-generator-cli version-manager set 7.12.0 | ||
|
|
||
| # Generate the client | ||
| npx @openapitools/openapi-generator-cli generate \ | ||
| -i ./gen/openapi.yaml \ | ||
| -g python \ | ||
| -c ./gen/config.json \ | ||
| -o . | ||
| ``` | ||
|
|
||
| ### After Generation | ||
|
|
||
| ```bash | ||
| # Build the package | ||
| uv build | ||
|
|
||
| # Optionally publish the package | ||
| uv publish | ||
| ``` | ||
|
|
||
| ### Important Notes | ||
|
|
||
| - The OpenAPI spec at `./gen/openapi.yaml` is the source of truth for this client | ||
| - Update this spec file first if you need to update the API client | ||
| - The configuration in `./gen/config.json` specifies the package name as "codegen_api_client" | ||
| - GitHub workflows handle testing and publishing, but not regeneration | ||
|
|
||
| --- | ||
|
|
||
| This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: | ||
|
|
||
| - API version: 1.0.0 | ||
|
|
@@ -114,6 +168,3 @@ Endpoints do not require authorization. | |
|
|
||
| ## Author | ||
|
|
||
|
|
||
|
|
||
|
|
||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are you modifying this @codegen? we need to use
uvThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll review the workflow to ensure
uvis used as intended! 🔎💻 View my work • 🛑 Stop
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're absolutely right! I've fixed the GitHub workflow file to use
uvinstead of pip. 👍The issue was that the OpenAPI generator overwrote the GitHub workflow file with its default template that uses pip instead of
uv. I've restored the original workflow configuration that uses:astral-sh/setup-uv@v5for setting up the UV package manageruv run pytestfor running the testsThe changes have been pushed to the same PR. Thanks for catching this! The OpenAPI spec and client code have been updated while maintaining the UV package manager configuration.
🔄 View Updated PR #4 on Github 🔄
💻 View my work • 🛑 Stop • React 👍 or 👎