Esmerald

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.

Changed

- Updated requirements for Pydantic and Starlette.
- Removed unnecessary dependencies.

Added

- Support for async `has_permission` on Permissions.
- Add new landing page.

Fixed

- `email-validator` error being thrown from `openapi-schemas-pydantic` requirement.

Changed

- Updated the way `esmerald` client operates internally.
- Updated internal minimum requirements.

Fix

- Regression in OpenAPI when adding middleware to `Gateway` or `HTTPHandler`. When a middleware
was added, the OpenAPI would not generate the docs for it. The API would still work but not OpenAPI
docs.

Changed

- Updated functional internal crypto to only use the system random.
- Cleaner codebase for the application settings.
- Updated version of Asyncz to be at least 0.5.0.

Added

- Custom exception handlers, `from esmerald.exception_handlers import value_error_handler`.
- New native exception handler for pydantic v2 Validation errors in general.
- Dataclasses (normal and Pydantic dataclases) are now supported as Esmerald Responses.
- Support for [OpenAPI Webhooks](./routing/webhooks.md).
- Improved [Responses](./responses.md) documentation with examples using Pydantic BaseModel and dataclasses.
- OpenAPI Spotlight Elements documentation. When starting the application, accesing the default `/docs/elements`.
- Support for [Edgy](https://edgy.tarsild.io) ORM. [Docs here](https://esmerald.dev/databases/edgy/motivation/).

Fixed

- Removed old pydantic v1 syntax from tests and applications.
- `add_include()` that wasn't generating signature models upon import.
- OpenAPI query params with defaults weren't loading properly.