Files
fastapi-users/mkdocs.yml
François Voron 373157c284 Finalize user activation feature (#439)
* Add routes for user activation (#403)

* Add routes for user activation

Generate a token after creating the user in register route, passing to `activation_callback`, if `activation_callback` supplied
Create new `/activate` route that will verify the token and activate the user
Add new error codes to `fastapi_users/router/common.py`
Update documentation
Add tests

Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk>

* Rework routes for user activation

* Separate verification logic and token generation into `/fastapi_users/router/verify.py`, with per-route callbacks for custom behaviour

* Return register router to original state

* Added `is_verified` property to user models

* Added `requires_verification` argument to `get_users_router`and `get_auth_router`

* Additional dependencies added for verification in `fastapi_users/authentication/__init__.py`

* Update tests for new behaviour

* Update `README.md` to describe a workaround for possible problems during testing, by exceeding ulimit file descriptor limit

Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk>

* Restored docs to original state.

* All other modifications reqested added

Kebab-case on request-verify-token
SECRET now used as test string
Other minor changes

Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk>

* Embed token in body in verify route

* Reorganize checks in verify route and add unit test

* Ignore coverage on Protocol classes

* Tweak verify_user function to take full user in parameter

* Improve unit tests structure regarding parametrized test client

* Make after_verification_request optional to be more consistent with other routers

* Tweak status codes on verify routes

* Write documentation for verification feature

* Add not released warning on verify docs

Co-authored-by: Edd Salkield <edd@salkield.uk>
Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk>
2021-01-12 10:44:42 +01:00

60 lines
1.5 KiB
YAML

site_name: FastAPI Users
site_description: Ready-to-use and customizable users management for FastAPI
theme:
name: 'material'
palette:
primary: 'red'
accent: 'red'
icon:
logo: material/account-supervisor
favicon: 'favicon.png'
repo_name: frankie567/fastapi-users
repo_url: https://github.com/frankie567/fastapi-users
edit_uri: ""
markdown_extensions:
- markdown_include.include:
base_path: docs
- toc:
permalink: true
- admonition
- codehilite
- pymdownx.superfences
- pymdownx.tasklist
- pymdownx.tabbed
nav:
- About: index.md
- installation.md
- Configuration:
- configuration/model.md
- Databases:
- configuration/databases/sqlalchemy.md
- configuration/databases/mongodb.md
- configuration/databases/tortoise.md
- Authentication:
- Introduction: configuration/authentication/index.md
- configuration/authentication/jwt.md
- configuration/authentication/cookie.md
- Routers:
- Introduction: configuration/routers/index.md
- configuration/routers/auth.md
- configuration/routers/register.md
- configuration/routers/reset.md
- configuration/routers/users.md
- configuration/routers/verify.md
- configuration/full_example.md
- configuration/oauth.md
- Usage:
- usage/flow.md
- usage/routes.md
- usage/dependency-callables.md
- usage/helpers.md
- Migration:
- migration/08_to_1x.md
- migration/1x_to_2x.md
- migration/2x_to_3x.md
- migration/3x_to_4x.md