Repair docs (html, md). Update docstrings
This commit is contained in:
parent
e264750187
commit
6a4ad48577
125 changed files with 3706 additions and 4913 deletions
36
SRV/docs/_build/markdown/api/models/auth.md
vendored
36
SRV/docs/_build/markdown/api/models/auth.md
vendored
|
|
@ -4,13 +4,14 @@
|
|||
|
||||
Bases: `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*
|
||||
|
||||
|
|
@ -28,12 +29,13 @@ Configuration for the model, should be a dictionary conforming to [ConfigDict][p
|
|||
|
||||
Bases: `BaseModel`
|
||||
|
||||
Модель созданного пользователя
|
||||
Модель созданного пользователя.
|
||||
|
||||
Атрибуты:
|
||||
: username (str): Имя пользователя
|
||||
password (str): Пароль пользователя
|
||||
is_admin (bool): Административный доступ
|
||||
|
||||
- `username` (str): Имя пользователя.
|
||||
- `password` (str): Пароль пользователя.
|
||||
- `is_admin` (bool): Флаг административного доступа.
|
||||
|
||||
#### is_admin *: bool*
|
||||
|
||||
|
|
@ -49,11 +51,12 @@ Configuration for the model, should be a dictionary conforming to [ConfigDict][p
|
|||
|
||||
Bases: `BaseModel`
|
||||
|
||||
Модель авторизации пользователя
|
||||
Модель авторизации пользователя.
|
||||
|
||||
Атрибуты:
|
||||
: username (str): Имя пользователя
|
||||
password (str): Пароль пользователя
|
||||
|
||||
- `username` (str): Имя пользователя.
|
||||
- `password` (str): Пароль пользователя.
|
||||
|
||||
#### model_config *: ClassVar[ConfigDict]* *= {}*
|
||||
|
||||
|
|
@ -67,12 +70,13 @@ Configuration for the model, should be a dictionary conforming to [ConfigDict][p
|
|||
|
||||
Bases: `BaseModel`
|
||||
|
||||
Модель проверки наличия пользователя
|
||||
Модель, используемая при возврате сведений о пользователе.
|
||||
|
||||
Атрибуты:
|
||||
: id (int): Идентификатор
|
||||
username (str): Имя пользователя
|
||||
is_admin (bool): Административный доступ
|
||||
|
||||
- `id` (int): Идентификатор пользователя.
|
||||
- `username` (str): Имя пользователя.
|
||||
- `is_admin` (bool): Флаг административного доступа.
|
||||
|
||||
#### id *: int*
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue