Openapi-python-client

1176 by Viicos

Set `defer_build` to models that we know will fail to build, and call `model_rebuild`
in the `__init__.py` file.

This change switches the YAML parsing library to `ruamel.yaml` which follows the YAML 1.2 specification.
[There are breaking changes](https://yaml.readthedocs.io/en/latest/pyyaml/#defaulting-to-yaml-12-support) 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.

Features

Adding support for named integer enums

1214 by barrybarrette

Adding support for named integer enums via an optional extension, `x-enum-varnames`.

This extension is added to the schema inline with the `enum` definition:

"MyEnum": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
99
],
"type": "integer",
"format": "int32",
"x-enum-varnames": [
"Deinstalled",
"Installed",
"Upcoming_Site",
"Lab_Site",
"Pending_Deinstall",
"Suspended",
"Install_In_Progress",
"Unknown"
]
}


The result:

Fixes

Make lists of models and enums work correctly in custom templates

Lists of model and enum classes should be available to custom templates via the Jinja
variables `openapi.models` and `openapi.enums`, but these were being passed in a way that made
them always appear empty. This has been fixed so a custom template can now iterate over them.

Closes 1188.

Features

- allow Ruff to 0.10 (1220)
- allow Ruff 0.11 (1222)
- Allow any `Mapping` in generated `from_dict` functions (1211)

Fixes

Always parse `$ref` as a reference

If additional attributes were included with a `$ref` (for example `title` or `description`), the property could be
interpreted as a new type instead of a reference, usually resulting in `Any` in the generated code.
Now, any sibling properties to `$ref` will properly be ignored, as per the OpenAPI specification.

Thanks nkrishnaswami!

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.