Skip to content

Commit 073ed01

Browse files
author
GitHub
committed
chore: prepare release 0.17.0
1 parent 3253448 commit 073ed01

4 files changed

+30
-30
lines changed

.changeset/openapi_31_support.md

-22
This file was deleted.

.changeset/removed_query_parameter_nullablerequired_special_case.md

-7
This file was deleted.

CHANGELOG.md

+29
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,35 @@ 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.17.0 (2023-12-31)
17+
18+
### Breaking Changes
19+
20+
#### Removed query parameter nullable/required special case
21+
22+
In previous versions, setting _either_ `nullable: true` or `required: false` on a query parameter would act like both were set, resulting in a type signature like `Union[None, Unset, YourType]`. This special case has been removed, query parameters will now act like all other types of parameters.
23+
24+
### Features
25+
26+
#### OpenAPI 3.1 support
27+
28+
The generator will now attempt to generate code for OpenAPI documents with versions 3.1.x (previously, it would exit immediately on seeing a version other than 3.0.x). The following specific OpenAPI 3.1 features are now supported:
29+
30+
- `null` as a type
31+
- Arrays of types (e.g., `type: [string, null]`)
32+
- `const` (defines `Literal` types)
33+
34+
The generator does not currently validate that the OpenAPI document is valid for a specific version of OpenAPI, so it may be possible to generate code for documents that include both removed 3.0 syntax (e.g., `nullable`) and new 3.1 syntax (e.g., `null` as a type).
35+
36+
Thanks to everyone who helped make this possible with discussions and testing, including:
37+
38+
- @frco9
39+
- @vogre
40+
- @naddeoa
41+
- @staticdev
42+
- @philsturgeon
43+
- @johnthagen
44+
1645
## 0.16.1 (2023-12-23)
1746

1847
### Features

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "openapi-python-client"
3-
version = "0.16.1"
3+
version = "0.17.0"
44
description = "Generate modern Python clients from OpenAPI"
55
repository = "https://github.com/triaxtec/openapi-python-client"
66
license = "MIT"

0 commit comments

Comments
 (0)