python/fastapi-users
1
0
Fork 0
mirror of https://github.com/fastapi-users/fastapi-users.git synced 2026-03-13 07:49:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Prepare docs for v5 release

Browse Source
This commit is contained in:
François Voron
2021-01-12 11:24:52 +01:00
parent 1df6e7d162
commit 9c113e30a2
3 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/configuration/routers/verify.md
View File

@@ -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 "👏👏👏"

7
docs/migration/4x_to_5x.md Normal file
View File

@@ -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.

3
docs/usage/routes.md
View File

@@ -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.