Skip to content

Commit cbdd006

Browse files
Release 0.29.1
1 parent 1c99af4 commit cbdd006

8 files changed

Lines changed: 63 additions & 66 deletions

.changeset/arbitrary_code_generation_vulnerability.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

.changeset/breaking_changes_for_all_custom_templates.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

.changeset/fixed_invalid_identifiers_when_resolving_naming_conflicts.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

.changeset/many_control_characters_now_stripped_from_string_literals.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

.changeset/render_error_data_as_json.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

.changeset/stopped_generating_empty_docstrings_for_models_with_no_description.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,68 @@ Programmatic usage of this project (e.g., importing it as a Python module) and t
1313

1414
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).
1515

16+
## 0.29.1 (2026-08-30)
17+
18+
### 🚨Security
19+
20+
#### Arbitrary code generation vulnerability
21+
22+
Prior to this release, malicious OpenAPI documents could cause openapi-python-client to generate arbitrary code, which
23+
would then be executed by consumers of the generated client.
24+
25+
If you generate code from OpenAPI documents you don't control, you should upgrade to this release as **soon as possible**
26+
and validate any previously-generated code.
27+
28+
See [the GitHub advisory](https://github.com/openapi-generators/openapi-python-client/security/advisories/GHSA-5293-mq8x-g3xj) for more details.
29+
30+
### 🚀 Features
31+
32+
- Update `uv_build` to 0.12 when using `--meta=uv` (#1473)
33+
34+
### 🐛 Fixes
35+
36+
- Apply PEP 639 for improved license metadata (#1459)
37+
- update generated code to use `StrEnum` and `-> Self` (#1474)
38+
- Remove trailing spaces in README example code (#1475)
39+
- Stopped generating empty docstrings for models with no description
40+
41+
#### Fixed invalid Python identifiers when resolving naming conflicts
42+
43+
When two property or parameter names conflicted after conversion to `snake_case` (e.g. `foo-bar` and `fooBar`), the conflict-resolution path preserved delimiters like `-`, `.`, and spaces in the generated Python identifiers, producing invalid code which failed generation. Conflicting names now keep their original casing but have any characters which are invalid in Python identifiers stripped (e.g. `foobar` and `fooBar`).
44+
45+
#### Improve readability of error messages
46+
47+
Errors and warnings which include a snippet of your OpenAPI document now render that snippet as JSON, making them much easier to read.
48+
49+
### 📝Notes
50+
51+
#### Breaking changes for all custom templates
52+
53+
**ALL** custom templates are expected to break with this version as a result of the security fix.
54+
55+
1. The `utils` global has been renamed to `strings`
56+
2. Most string values can no longer be rendered directly into templates,
57+
you must describe how the value is being used so it can be properly escaped using either a Python function or Jinja filter:
58+
1. `strings.snake_case()` / `| snakecase` (existing)
59+
2. `strings.kebab_case()` / `| kebabcase` (existing)
60+
3. `strings.pascal_case()` / `| pascalcase` (existing)
61+
4. `python_identifier()` (existing)
62+
5. `class_name()` (existing)
63+
6. `strings.safe_for_docstring()` / `| safe_for_docstring` for values which get injected into a `"""` docstring
64+
7. `strings.in_f_string_literal()` / `| in_f_string_literal` for values that go into `f""` f-strings
65+
8. `strings.in_double_quote_literal()` / `| in_double_quote_literal` for values that go into **non-f-string** `""` literals
66+
9. `.as_unembedded_code()` / `| as_unembedded_code` ONLY for `PythonCode` values—those that are intended to be Python code which is not embedded into any string/docstring. Examples include usages of `.python_code`, `.get_type_string()`, `.get_instance_type_string()`, `.get_type_strings_in_union()`. You *should not* assume these values are safe to put in docstrings, string literals, or f-string literals. Use the dedicated helpers for those.
67+
As always, you can check the diff of the built in templates for examples. You will also want to check generated output
68+
for "UntrustedString", which is how any string now requiring one of those functions will appear.
69+
70+
#### Many control characters now stripped from string literals
71+
72+
Out of an abundance of caution, most Unicode control characters are now stripped from string literals.
73+
If your API uses control characters as part of const values, enums, or JSON body property names you may have issues
74+
with this new version.
75+
76+
Most APIs are not expected to be affected by this change.
77+
1678
## 0.29.0 (2026-05-30)
1779

1880
### Breaking Changes

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ dependencies = [
1616
"ruff>=0.2",
1717
]
1818
name = "openapi-python-client"
19-
version = "0.29.0"
19+
version = "0.29.1"
2020
description = "Generate modern Python clients from OpenAPI"
2121
keywords = [
2222
"OpenAPI",

0 commit comments

Comments
 (0)