0.21.1 (2024-06-15)

Features

Support request body refs

You can now define and reuse bodies via refs, with a document like this:

paths:
/something:
post:
requestBody:
"$ref": "#/components/requestBodies/SharedBody"
components:
requestBodies:
SharedBody:
content:
application/json:
schema:
type: string

Thanks to @kigawas and @supermihi for initial implementations and @RockyMM for the initial request.

Closes #633, closes #664, resolves #595.

Fixes

• Indent of generated code for non-required lists. Thanks @sfowl! (#1050)
• Parsing requestBody with $ref (#633)

0.21.0 (2024-06-08)

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 #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.

0.20.0 (2024-05-18)

Breaking Changes

const values in responses are now validated at runtime

Prior to this version, const values returned from servers were assumed to always be correct. Now, if a server returns
an unexpected value, the client will raise a ValueError. This should enable better usage with oneOf.

PR #1024. Thanks @peter-greenatlas!

Switch YAML parsing to 1.2

This change switches the YAML parsing library to ruamel.yaml which follows the YAML 1.2 specification.
There are breaking changes from YAML 1.1 to 1.2,
though they will not affect most use cases.

PR #1042 fixes #1041. Thanks @rtaycher!

Features

• allow Ruff 0.4 (#1031)

Fixes

Fix nullable and required properties in multipart bodies

Fixes #926.

Warning

This change is likely to break custom templates. Multipart body handling has been completely split from JSON bodies.

0.19.1 (2024-03-27)

Features

Add config option to override content types

You can now define a content_type_overrides field in your config.yml:

content_type_overrides:
application/zip: application/octet-stream

This allows openapi-python-client to generate code for content types it doesn't recognize.

PR #1010 closes #810. Thanks @gaarutyunov!

Fixes

Add aliases to Client for pyright

This should resolve incompatibilities between the generated Client class and the pyright type checker.

PR #1009 closes #909. Thanks @patrick91!

0.19.0 (2024-03-06)

Breaking Changes

Update PDM metadata syntax

Metadata generated for PDM will now use the new distribution = true syntax instead of package-type = "library".
New packages generated with --meta pdm will require PDM 2.12.0 or later to build.

Features

Add response content to UnexpectedStatus exception

The error message for UnexpectedStatus exceptions will now include the UTF-8 decoded (ignoring errors) body of the response.

PR #989 implements #840. Thanks @harabat!

Fixes

Allow hyphens in path parameters

Before now, path parameters which were invalid Python identifiers were not allowed, and would fail generation with an
"Incorrect path templating" error. In particular, this meant that path parameters with hyphens were not allowed.
This has now been fixed!

PR #986 fixed issue #976. Thanks @harabat!

Warning

This change may break custom templates, see this diff
if you have trouble upgrading.

0.18.0 (2024-02-22)

Breaking Changes

For custom templates, changed type of endpoint parameters

This does not affect projects that are not using --custom-template-path

The type of these properties on Endpoint has been changed from Dict[str, Property] to List[Property]:

• path_parameters
• query_parameters
• header_parameters
• cookie_parameters

If your templates are very close to the default templates, you can probably just remove .values() anywhere it appears.

The type of iter_all_parameters() is also different, you probably want list_all_parameters() instead.

Updated generated config for Ruff v0.2

This only affects projects using the generate command, not the update command. The pyproject.toml file generated which configures Ruff for linting and formatting has been updated to the 0.2 syntax, which means it will no longer work with Ruff 0.1.

Updated naming strategy for conflicting properties

While fixing #922, some naming strategies were updated. These should mostly be backwards compatible, but there may be
some small differences in generated code. Make sure to check your diffs before pushing updates to consumers!

Features

support httpx 0.27 (#974)

Fixes

Allow parameters with names differing only by case

If you have two parameters to an endpoint named mixedCase and mixed_case, previously, this was a conflict and the endpoint would not be generated.
Now, the generator will skip snake-casing the parameters and use the names as-is. Note that this means if neither of the parameters was snake case, neither will be in the generated code.

Fixes #922 reported by @macmoritz & @benedikt-bartscher.

Fix naming conflicts with properties in models with mixed casing

If you had an object with two properties, where the names differed only by case, conflicting properties would be generated in the model, which then failed the linting step (when using default config). For example, this:

type: "object"
properties:
MixedCase:
type: "string"
mixedCase:
type: "string"

Would generate a class like this:

class MyModel:
mixed_case: str
mixed_case: str

Now, neither of the properties will be forced into snake case, and the generated code will look like this:

class MyModel:
MixedCase: str
mixedCase: str

0.17.3 (2024-02-20)

Fixes

Remove spurious field_dict.update({}) for types without properties (#969)

Fix invalid type check for nested unions

Nested union types (unions of unions) were generating isinstance() checks that were not valid (at least for Python 3.9).

Thanks to @codebutler for PR #959 which fixes #958 and #967.

0.17.2 (2024-01-15)

Features

Add --meta=pdm option for generating PEP621 + PDM metadata

The default metadata is still --meta=poetry, which generates a pyproject.toml file with Poetry-specific metadata.
This change adds the --meta=pdm option which includes PDM-specific metadata, but also
standard PEP621
metadata. This may be useful as a starting point for other dependency managers & build tools (like Hatch).

Add original OpenAPI data attribute to Response object

PR #767

In custom templates, you can now access a response.data attribute that contains the original OpenAPI definition of the
response (Response Object or Reference Object).

Include the UP rule for generated Ruff config

This enables pyupgrade-like improvements which should replace some
.format() calls with f-strings.

Fixes

Fix Ruff formatting for --meta=none

PR #940 fixes issue #939. Thanks @satwell!

Due to the lack of pyproject.toml, Ruff was not getting configured properly when --meta=none.
As a result, it didn't clean up common generation issues like duplicate imports, which would then cause errors from
linters.

This is now fixed by changing the default post_hook to ruff check . --fix --extend-select=I when --meta=none.
Using generate --meta=none should now be almost identical to the code generated by update.

0.17.1 (2024-01-04)

Features

Export Unset types from generated types.py (#927)

Generate properties for some boolean enums

If a schema has both type = "boolean" and enum defined, a normal boolean property will now be created.
Previously, the generator would error.

Note that the generate code will not correctly limit the values to the enum values. To work around this, use the
OpenAPI 3.1 const instead of enum to generate Python Literal types.

Thanks for reporting #922 @macmoritz!

Fixes

Do not stop generation for invalid enum values

This generator only supports enum values that are strings or integers.
Previously, this was handled at the parsing level, which would cause the generator to fail if there were any unsupported values in the document.
Now, the generator will correctly keep going, skipping only endpoints which contained unsupported values.

Thanks for reporting #922 @macmoritz!

Fix lists within unions

Fixes #756 and #928. Arrays within unions (which, as of 0.17 includes nullable arrays) would generate invalid code.

Thanks @kgutwin and @diesieben07!

Simplify type checks for non-required unions

0.17.0 (2023-12-31)

Breaking Changes

Removed query parameter nullable/required special case

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.

Renamed body types and parameters

PR #900 addresses #822.

Where previously there would be one body parameter per supported content type, now there is a single body parameter which takes a union of all the possible inputs. This correctly models the fact that only one body can be sent (and ever would be sent) in a request.

For example, when calling a generated endpoint, code which used to look like this:

post_body_multipart.sync_detailed(
client=client,
multipart_data=PostBodyMultipartMultipartData(),
)

Will now look like this:

post_body_multipart.sync_detailed(
client=client,
body=PostBodyMultipartBody(),
)

Note that both the input parameter name and the class name have changed. This should result in simpler code when there is only a single body type and now produces correct code when there are multiple body types.

Features

OpenAPI 3.1 support

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:

• null as a type
• Arrays of types (e.g., type: [string, null])
• const (defines Literal types)

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

Thanks to everyone who helped make this possible with discussions and testing, including:

• @frco9
• @vogre
• @naddeoa
• @staticdev
• @philsturgeon
• @johnthagen

Support multiple possible requestBody

PR #900 addresses #822.

It is now possible in some circumstances to generate valid code for OpenAPI documents which have multiple possible requestBody values. Previously, invalid code could have been generated with no warning (only one body could actually be sent).

Only one content type per "category" is currently supported at a time. The categories are:

• JSON, like application/json
• Binary data, like application/octet-stream
• Encoded form data, like application/x-www-form-urlencoded
• Files, like multipart/form-data

Fixes

Always use correct content type for requests

In previous versions, a request body that was similar to a known content type would use that content type in the request. For example application/json would be used for application/vnd.api+json. This was incorrect and could result in invalid requests being sent.

Now, the content type defined in the OpenAPI document will always be used.