chore: prepare release 0.21.0 #1053
Merged
Conversation
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
micha91
pushed a commit
to micha91/openapi-python-client
that referenced
this pull request
May 13, 2025
This PR was created by Knope. Merging it will create a new release ### Breaking Changes #### Removed the `update` command The `update` command is no more, you can (mostly) replace its usage with some new flags on the `generate` command. If you had a package named `my-api-client` in the current working directory, the `update` command previously would update the `my_api_client` module within it. You can now _almost_ perfectly replicate this behavior using `openapi-python-client generate --meta=none --output-path=my-api-client/my_api_client --overwrite`. The only difference is that `my-api-client` would have run `post_hooks` in the `my-api-client` directory, but `generate` will run `post_hooks` in the `output-path` directory. Alternatively, you can now also run `openapi-python-client generate --meta=<your-meta-type> --overwrite` to regenerate the entire client, if you don't care about keeping any changes you've made to the generated client. Please comment on [discussion openapi-generators#824](openapi-generators#824) (or a new discussion, as appropriate) to aid in designing future features that fill any gaps this leaves for you. ### Features #### Added an `--output-path` option to `generate` Rather than changing directories before running `generate` you can now specify an output directory with `--output-path`. Note that the project name will _not_ be appended to the `--output-path`, whatever path you specify is where the generated code will be placed. #### Added an `--overwrite` flag to `generate` You can now tell `openapi-python-client` to overwrite an existing directory, rather than deleting it yourself before running `generate`. Co-authored-by: GitHub <github-actions@github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR was created by Knope. Merging it will create a new release
Breaking Changes
Removed the
updatecommandThe
updatecommand is no more, you can (mostly) replace its usage with some new flags on thegeneratecommand.If you had a package named
my-api-clientin the current working directory, theupdatecommand previously would update themy_api_clientmodule within it. You can now almost perfectly replicate this behavior usingopenapi-python-client generate --meta=none --output-path=my-api-client/my_api_client --overwrite.The only difference is that
my-api-clientwould have runpost_hooksin themy-api-clientdirectory,but
generatewill runpost_hooksin theoutput-pathdirectory.Alternatively, you can now also run
openapi-python-client generate --meta=<your-meta-type> --overwriteto regeneratethe entire client, if you don't care about keeping any changes you've made to the generated client.
Please comment on discussion #824
(or a new discussion, as appropriate) to aid in designing future features that fill any gaps this leaves for you.
Features
Added an
--output-pathoption togenerateRather than changing directories before running
generateyou can now specify an output directory with--output-path.Note that the project name will not be appended to the
--output-path, whatever path you specify is where thegenerated code will be placed.
Added an
--overwriteflag togenerateYou can now tell
openapi-python-clientto overwrite an existing directory, rather than deleting it yourself beforerunning
generate.