From 21f23f19395716736fdd21ac145beda1b36a7b35 Mon Sep 17 00:00:00 2001 From: "knope-bot[bot]" <152252888+knope-bot[bot]@users.noreply.github.com> Date: Mon, 3 Mar 2025 01:23:00 +0000 Subject: [PATCH] Release 0.24.0 --- .changeset/config_in_templates.md | 7 ------- .changeset/docstrings_on_attributes.md | 7 ------- .changeset/support_ref_in_responses.md | 12 ------------ CHANGELOG.md | 23 +++++++++++++++++++++++ pyproject.toml | 2 +- 5 files changed, 24 insertions(+), 27 deletions(-) delete mode 100644 .changeset/config_in_templates.md delete mode 100644 .changeset/docstrings_on_attributes.md delete mode 100644 .changeset/support_ref_in_responses.md diff --git a/.changeset/config_in_templates.md b/.changeset/config_in_templates.md deleted file mode 100644 index 7b34f7497..000000000 --- a/.changeset/config_in_templates.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -default: minor ---- - -# Make `config` available in custom templates - -The configuration options object is now exposed as a variable called `config` in Jinja2 templates. diff --git a/.changeset/docstrings_on_attributes.md b/.changeset/docstrings_on_attributes.md deleted file mode 100644 index b87bcee11..000000000 --- a/.changeset/docstrings_on_attributes.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -default: minor ---- - -# Add `docstrings_on_attributes` config setting - -Setting this option to `true` changes the docstring behavior in model classes: for any attribute that have a non-empty `description`, instead of describing the attribute as part of the class's docstring, the description will appear in an individual docstring for that attribute. diff --git a/.changeset/support_ref_in_responses.md b/.changeset/support_ref_in_responses.md deleted file mode 100644 index a850450e1..000000000 --- a/.changeset/support_ref_in_responses.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -default: major ---- - -# Support `$ref` in responses - -Previously, using a `$ref` to define a response was ignored, the code to call the endpoint was still generated, but -the response would not be parsed. Now, responses defined with `$ref` will be used to generate the response model, which -will parse the response at runtime. - -If a `$ref` is incorrect or uses a feature that is not supported by the generator, these endpoints will start failing to -generate. diff --git a/CHANGELOG.md b/CHANGELOG.md index 2de472949..96fbb4e61 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,29 @@ Programmatic usage of this project (e.g., importing it as a Python module) and t The 0.x prefix used in versions for this project is to indicate that breaking changes are expected frequently (several times a year). Breaking changes will increment the minor number, all other changes will increment the patch number. You can track the progress toward 1.0 [here](https://github.com/openapi-generators/openapi-python-client/projects/2). +## 0.24.0 (2025-03-03) + +### Breaking Changes + +#### Support `$ref` in responses + +Previously, using a `$ref` to define a response was ignored, the code to call the endpoint was still generated, but +the response would not be parsed. Now, responses defined with `$ref` will be used to generate the response model, which +will parse the response at runtime. + +If a `$ref` is incorrect or uses a feature that is not supported by the generator, these endpoints will start failing to +generate. + +### Features + +#### Make `config` available in custom templates + +The configuration options object is now exposed as a variable called `config` in Jinja2 templates. + +#### Add `docstrings_on_attributes` config setting + +Setting this option to `true` changes the docstring behavior in model classes: for any attribute that have a non-empty `description`, instead of describing the attribute as part of the class's docstring, the description will appear in an individual docstring for that attribute. + ## 0.23.1 (2025-01-13) ### Features diff --git a/pyproject.toml b/pyproject.toml index cc257dbdf..ffacf7b8b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,7 @@ dependencies = [ "typing-extensions>=4.8.0,<5.0.0", ] name = "openapi-python-client" -version = "0.23.1" +version = "0.24.0" description = "Generate modern Python clients from OpenAPI" keywords = [ "OpenAPI",