📃 Updated Release notes (#114)

dymmond · Jul 13, 2023 · bafe1c9 · bafe1c9
2 parents bfe5dc1 + c81fef0
commit bafe1c9
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 19 deletions.
diff --git a/docs/configurations/openapi/config.md b/docs/configurations/openapi/config.md
@@ -160,11 +160,6 @@ settings.
 {!> ../docs_src/configurations/openapi/settings.py!}
 ```
 
-!!! Warning
-    We did import the `MyOpenAPIView` inside the property itself and the reason for it is to avoid import errors
-    or any `mro` issues. Since the app once starts runs the settings once, there is no problem since it will not
-    reconfigure on every single request.
-
 Start the server with your custom settings.
 
 ```shell

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,5 +1,38 @@
 # Release Notes
 
+## 2.0.0
+
+!!! Warning
+	When upgrading Esmerald to version 2, this also means the use of Pydantic 2.0 at its core as well as corresponsing technologies
+	already updated to version 2 of Pydantic (Saffier, Asyncz...).
+	If you still wish to continue to use Pydantic 1 with Esmerald, it is recommended to use Esmerald prior to version 2.0 which it will
+	be maintained for a shor period but we **strongly recommend to always use the latest version**.
+
+### Changed
+
+- **Major update of the core of Esmerald from Pydantic v1 to Pydantic v2.**
+- Changed deprecated functions such as `validator` and `root_validator` to `field_validator` and `model_validator`.
+- Transformers no longer support custom fields. Pydantic natively handles that.
+- EsmeraldSignature updated for the new version of the FieldInfo.
+- `params` reflect the new Pydantic FieldInfo.
+- Deprecated OpenAPIView in favour of the new OpenAPI documentation generator.
+- Changed OpenAPI config to reflect the new generation of OpenAPI documentation.
+- Internal data field is now returning Body type parameter making it easier to integrate with Pydantic 2.0.
+- General codebase cleanup.
+- Removed old OpenAPI document generator in favour to the newest, fastest, simplest and more effective approach in v2.
+- Remove the support of pydantic 1.0. Esmerald 2+ will only support pydantic 2+.
+
+### Added
+
+- OpenAPI support for OAuth2.
+
+### Fixed
+
+- FileResponse `stat_result` and Stream `iterator` typing.
+- Fix typing across the whole codebase.
+- Transformers are now generating Param fields directly.
+- Updated __fields__ in favour of the new pydantic model_fields approach.
+
 ## 1.3.0
 
 ### Changed

diff --git a/docs_src/configurations/openapi/example2.py b/docs_src/configurations/openapi/example2.py