Version 2.4.3

Fixed

• OpenAPI contact it was not parsing properly on transformation.
• Rename include attribute from Param (base) and call include_in_schema.
• Missing nest_asyncio dependency when using esmerald shell.

Version 2.4.2

Changed

• Pin starlette version to 0.32.0.post1

Version 2.4.1

Fix

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

Version 2.4.0

Changed

• Updated SwaggerUI version.
• Updated responses with a msgspec response example.

Added

• Support for payload as alternative to data. This aims
  to make the process more intuitive and easy to implement. #199.
• Context - The new context object for the handlers.
• Support for msgspec 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 document.
• Removed the use of random for the secrets in favour of the secrets library instead.
• Contrib documentation updates regarding the Authorization headers.

Version 2.3.1

Fixed

• Middleware as an independent ASGI app on an Include level.

!!! Warning
This was supposed to go in the release 2.3.0 but it was not merged on time to make the
release.

Version 2.3.0

Changed

• OpenAPI fields are permanently moved to OpenAPIConfig
  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.
object instead.

Added

• Annotated for documentation generators.
• Add new documentation structure for Esmerald base.
• Add API Reference . #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.

Version 2.2.0

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 by @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 supported.
• New 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.

Version 2.1.0

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 by @ShahriyarR.
• Support for Mongoz showcasing how to integrate Esmerald with an ODM (MongoDB).
• Documentation about how to use Esmerald contrib with Mongoz.

Fixed

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

Version 2.0.6

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.

Version 2.0.5

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.