Files
Matyáš Richter c759bb6915 Extending generated OpenAPI docs (#799)
* Added login endpoint docs

* make format

* Changed login route into multiple examples.

* Added reset password router docs

* Updated /{id} routes for user

* Updated /me routes

* Fixed user already exists response description

* Updated the /register route

* Updated verify routes

* Updated oauth2 endpoints.

* Applied `make format`

* Renamed Authentication methods for getting their openapi schemas

- `get_login_responses_success` -> `get_openapi_login_responses_success`
- `get_logout_responses_success` -> `get_openapi_logout_responses_success`

* Fixed flake8 errors

* Not using `Final` to keep python37 compatibility

Co-authored-by: François Voron <fvoron@gmail.com>
2021-11-23 13:13:51 +01:00

88 lines
2.8 KiB
Python

from typing import Type
from fastapi import APIRouter, Body, Depends, HTTPException, Request, status
from pydantic import EmailStr
from fastapi_users import models
from fastapi_users.manager import (
BaseUserManager,
InvalidVerifyToken,
UserAlreadyVerified,
UserInactive,
UserManagerDependency,
UserNotExists,
)
from fastapi_users.router.common import ErrorCode, ErrorModel
def get_verify_router(
get_user_manager: UserManagerDependency[models.UC, models.UD],
user_model: Type[models.U],
):
router = APIRouter()
@router.post(
"/request-verify-token",
status_code=status.HTTP_202_ACCEPTED,
name="verify:request-token",
)
async def request_verify_token(
request: Request,
email: EmailStr = Body(..., embed=True),
user_manager: BaseUserManager[models.UC, models.UD] = Depends(get_user_manager),
):
try:
user = await user_manager.get_by_email(email)
await user_manager.request_verify(user, request)
except (UserNotExists, UserInactive, UserAlreadyVerified):
pass
return None
@router.post(
"/verify",
response_model=user_model,
name="verify:verify",
responses={
status.HTTP_400_BAD_REQUEST: {
"model": ErrorModel,
"content": {
"application/json": {
"examples": {
ErrorCode.VERIFY_USER_BAD_TOKEN: {
"summary": "Bad token, not existing user or"
"not the e-mail currently set for the user.",
"value": {"detail": ErrorCode.VERIFY_USER_BAD_TOKEN},
},
ErrorCode.VERIFY_USER_ALREADY_VERIFIED: {
"summary": "The user is already verified.",
"value": {
"detail": ErrorCode.VERIFY_USER_ALREADY_VERIFIED
},
},
}
}
},
}
},
)
async def verify(
request: Request,
token: str = Body(..., embed=True),
user_manager: BaseUserManager[models.UC, models.UD] = Depends(get_user_manager),
):
try:
return await user_manager.verify(token, request)
except (InvalidVerifyToken, UserNotExists):
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ErrorCode.VERIFY_USER_BAD_TOKEN,
)
except UserAlreadyVerified:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=ErrorCode.VERIFY_USER_ALREADY_VERIFIED,
)
return router