From 9c113e30a236f2c48150226bf0fbf15c8fd0496f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Voron?= Date: Tue, 12 Jan 2021 11:24:52 +0100 Subject: [PATCH] Prepare docs for v5 release --- docs/configuration/routers/verify.md | 3 --- docs/migration/4x_to_5x.md | 7 +++++++ docs/usage/routes.md | 3 --- 3 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 docs/migration/4x_to_5x.md diff --git a/docs/configuration/routers/verify.md b/docs/configuration/routers/verify.md index 49c29967..8337c3f3 100644 --- a/docs/configuration/routers/verify.md +++ b/docs/configuration/routers/verify.md @@ -1,8 +1,5 @@ # Verify router -!!! warning - This feature is not released yet. - This router provides routes to manage user email verification. Check the [routes usage](../../usage/routes.md) to learn how to use them. !!! success "👏👏👏" diff --git a/docs/migration/4x_to_5x.md b/docs/migration/4x_to_5x.md new file mode 100644 index 00000000..fc143937 --- /dev/null +++ b/docs/migration/4x_to_5x.md @@ -0,0 +1,7 @@ +# 4.x.x ➡️ 5.x.x + +## New property `is_verified` in `User` model. + +Starting 5.x.x., there is a new [e-mail verification feature](../configuration/routers/verify.md). Even if optional, the `is_verified` property has been added to the `User` model. + +If you use **SQLAlchemy** or **Tortoise** databases adapters, you'll have to make a migration to update your database schema. diff --git a/docs/usage/routes.md b/docs/usage/routes.md index 46bd1719..5263b046 100644 --- a/docs/usage/routes.md +++ b/docs/usage/routes.md @@ -119,9 +119,6 @@ Reset a password. Requires the token generated by the `/forgot-password` route. ## Verify router -!!! warning - This feature is not released yet. - ### `POST /request-verify-token` Request a user to verify their e-mail. Will generate a temporary token and call the `after_verification_request` [handler](../configuration/routers/verify.md#after-verification-request) if the user exists.