Esmerald

Fix

- Regression when performing a `model_dump` of pydantic models in the responses.
- Re-enable `orjson` for generic response parsing.

Changed

- Updated SwaggerUI version.
- Updated [responses](https://esmerald.dev/responses.md) with a `msgspec` response example.

Added

- Support for [payload](https://esmerald.dev/extras/request-data.md) as alternative to `data`. This aims
to make the process more intuitive and easy to implement. [199](https://github.com/dymmond/esmerald/pull/199).
- [Context](https://esmerald.dev/context.md) - The new context object for the [handlers](https://esmerald.dev/routing/handlers/).
- Support for [msgspec](https://esmerald.dev/msgspec.md) natively allowing to have more than just Pydantic.

!!! Note
Esmerald is not fully tight with Pydantic which means it's more flexible and extendible and allows more versatility.

Fixed

- Missing [Request](https://esmerald.dev/request.md) document.
- Removed the use of `random` for the secrets in favour of the `secrets` library instead.
- Contrib documentation updates regarding the Authorization headers.

Fixed

- `Middleware` as an independent ASGI app on an `Include` level.

!!! Warning
This was supposed to go in the release [2.3.0](230) but it was not merged on time to make the
release.

Changed

- OpenAPI fields are permanently moved to [OpenAPIConfig](https://esmerald.dev/configurations/openapi/config/)
making the codebase cleaner. The options are still available via `settings` in case of wanting to
override the defaults but not via instantiation parameters. Via instantiation the `OpenAPIConfig` is the
one to be used.

!!! Warning
This is a breaking change. The functionality itself still works as it is supposed to but from now on
instead of passing via Esmerald instance, you need to pass the variables via [OpenAPIConfig](https://esmerald.dev/configurations/openapi/config/).
object instead.

Added

- Annotated for documentation generators.
- Add new documentation structure for Esmerald base.
- Add [API Reference](https://esmerald.dev/references/) . [#196](https://github.com/dymmond/esmerald/pull/196)

Fixed

- Allow tags for levels. When a tag is added to an `Include`, `Gateway`, or any other level,
the tags are appended to the final handler. This allows inheriting from existing tags for OpenAPI.
- `Middleware` on levels treating each level as an independent ASGI app.

Changed

- Updated `OpenAPIConfig` documentation.
- Deprecate `v1`. Esmerald prior to version 2.0 is no longer supported.

Added

- Allow importing from from string into `Factory`. [179](https://github.com/dymmond/esmerald/pull/179) by [tarsil](https://github.com/tarsil).
- New security objects for OpenAPI documentation.
- New [OpenAPI][https://esmerald.dev/ openapi.md] documentation describing the ways of using it and what is available with examples.
- New [SimpleAPIView](https://esmerald.dev/ routing/apiview.md#simpleapiview) supported.
- New [CreateAPIView](https://esmerald.dev/routing/apiview.md#createapiview) supported.
- New [ReadAPIView](https://Esmerald.dev/routing/apiview.md#readapiview) supported.
- New [DeleteAPIView](https://esmerald.dev/ routing/apiview.md#deleteapiview) supported.
- New [ListAPIView](https://esmerald.dev/ routing/apiview.md#listapiview) supported.

Fixed

- OpenAPI `security` was not working as intended.

Changed

- Update base requirements and pydantic to 2.4.

Added

- New Factory added for dependency injection allowing to pass any time via Factory instantiation. [PR 163](https://github.com/dymmond/esmerald/pull/163) by [ShahriyarR](https://github.com/ShahriyarR).
- Support for [Mongoz](https://mongoz.tarsild.io) showcasing how to integrate Esmerald with an ODM (MongoDB).
- Documentation about how to use Esmerald contrib with [Mongoz](https://esmerald.dev/databases/mongoz/motivation.md).

Fixed

- Typos in the documentation.
- Pydantic 2.4 compatibility and updating to new names for the functions.