Repair docs (html, md). Update docstrings

This commit is contained in:
parent e264750187
commit 6a4ad48577
125 changed files with 3706 additions and 4913 deletions

View file

@ -3,13 +3,13 @@ from typing import Optional
class UserCreate(BaseModel):
"""
Модель созданного пользователя
"""Модель созданного пользователя.
Атрибуты:
username (str): Имя пользователя
password (str): Пароль пользователя
is_admin (bool): Административный доступ
- ``username`` (str): Имя пользователя.
- ``password`` (str): Пароль пользователя.
- ``is_admin`` (bool): Флаг административного доступа.
"""
username: str
@ -18,12 +18,12 @@ class UserCreate(BaseModel):
class UserLogin(BaseModel):
"""
Модель авторизации пользователя
"""Модель авторизации пользователя.
Атрибуты:
username (str): Имя пользователя
password (str): Пароль пользователя
- ``username`` (str): Имя пользователя.
- ``password`` (str): Пароль пользователя.
"""
username: str
@ -31,13 +31,13 @@ class UserLogin(BaseModel):
class UserResponse(BaseModel):
"""
Модель проверки наличия пользователя
"""Модель, используемая при возврате сведений о пользователе.
Атрибуты:
id (int): Идентификатор
username (str): Имя пользователя
is_admin (bool): Административный доступ
- ``id`` (int): Идентификатор пользователя.
- ``username`` (str): Имя пользователя.
- ``is_admin`` (bool): Флаг административного доступа.
"""
id: int
@ -46,14 +46,14 @@ class UserResponse(BaseModel):
class Token(BaseModel):
"""
Токен пользователя
"""Модель JWT-токена.
Атрибуты:
access_token (str): Токен пользователя (захэширован)
token_type (str): Тип токена
session_id (Optional[str]): Идентификатор сессии
user (Optional[UserResponse]): Пользователь на основе проверки наличия пользователя
- ``access_token`` (str): Значение токена (в формате JWT).
- ``token_type`` (str): Тип токена (обычно ``bearer``).
- ``session_id`` (Optional[str]): Идентификатор сессии.
- ``user`` (Optional[UserResponse]): Данные пользователя, если включены в ответ.
"""
access_token: str