Skip to content

Commit

Permalink
Release 2.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
tarsil committed Oct 27, 2023
1 parent d54061e commit 270513a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
26 changes: 26 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,32 @@ hide:

# Release Notes

## 2.3.0

### 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 genetators.
- Add new documentation structure for Esmerald base.
- Add [API Reference](http://localhost:8000/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.

## 2.2.0

### Changed
Expand Down
2 changes: 1 addition & 1 deletion esmerald/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "2.2.0"
__version__ = "2.3.0"


from starlette import status
Expand Down

0 comments on commit 270513a

Please sign in to comment.