HybrydMain/gonets
3
2
Fork 0
Code Issues 5 Pull requests Projects 1 Releases 3 Packages Wiki Activity Actions

Repair docs (html, md). Update docstrings

Browse source
This commit is contained in:
Галанский Сергей Александрович 2025-10-21 10:51:32 +05:00
parent e264750187
commit 6a4ad48577
125 changed files with 3706 additions and 4913 deletions
Download patch file Download diff file Expand all files Collapse all files

40
SRV/docs/_build/html/_modules/models/auth.html vendored
View file

@ -282,13 +282,13 @@
<div class="viewcode-block" id="UserCreate">
<a class="viewcode-back" href="../../api/models/auth.html#models.auth.UserCreate">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">UserCreate</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Модель созданного пользователя</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Модель созданного пользователя.</span>
<span class="sd"> Атрибуты:</span>
<span class="sd"> username (str): Имя пользователя</span>
<span class="sd"> password (str): Пароль пользователя</span>
<span class="sd"> is_admin (bool): Административный доступ</span>
<span class="sd"> - ``username`` (str): Имя пользователя.</span>
<span class="sd"> - ``password`` (str): Пароль пользователя.</span>
<span class="sd"> - ``is_admin`` (bool): Флаг административного доступа.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">username</span><span class="p">:</span> <span class="nb">str</span>
@ -300,12 +300,12 @@
<div class="viewcode-block" id="UserLogin">
<a class="viewcode-back" href="../../api/models/auth.html#models.auth.UserLogin">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">UserLogin</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Модель авторизации пользователя</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Модель авторизации пользователя.</span>
<span class="sd"> Атрибуты:</span>
<span class="sd"> username (str): Имя пользователя</span>
<span class="sd"> password (str): Пароль пользователя</span>
<span class="sd"> - ``username`` (str): Имя пользователя.</span>
<span class="sd"> - ``password`` (str): Пароль пользователя.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">username</span><span class="p">:</span> <span class="nb">str</span>
@ -316,13 +316,13 @@
<div class="viewcode-block" id="UserResponse">
<a class="viewcode-back" href="../../api/models/auth.html#models.auth.UserResponse">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">UserResponse</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Модель проверки наличия пользователя</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Модель, используемая при возврате сведений о пользователе.</span>
<span class="sd"> Атрибуты:</span>
<span class="sd"> id (int): Идентификатор</span>
<span class="sd"> username (str): Имя пользователя</span>
<span class="sd"> is_admin (bool): Административный доступ</span>
<span class="sd"> - ``id`` (int): Идентификатор пользователя.</span>
<span class="sd"> - ``username`` (str): Имя пользователя.</span>
<span class="sd"> - ``is_admin`` (bool): Флаг административного доступа.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">int</span>
@ -334,14 +334,14 @@
<div class="viewcode-block" id="Token">
<a class="viewcode-back" href="../../api/models/auth.html#models.auth.Token">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Token</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Токен пользователя</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Модель JWT-токена.</span>
<span class="sd"> Атрибуты:</span>
<span class="sd"> access_token (str): Токен пользователя (захэширован)</span>
<span class="sd"> token_type (str): Тип токена</span>
<span class="sd"> session_id (Optional[str]): Идентификатор сессии</span>
<span class="sd"> user (Optional[UserResponse]): Пользователь на основе проверки наличия пользователя</span>
<span class="sd"> - ``access_token`` (str): Значение токена (в формате JWT).</span>
<span class="sd"> - ``token_type`` (str): Тип токена (обычно ``bearer``).</span>
<span class="sd"> - ``session_id`` (Optional[str]): Идентификатор сессии.</span>
<span class="sd"> - ``user`` (Optional[UserResponse]): Данные пользователя, если включены в ответ.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">access_token</span><span class="p">:</span> <span class="nb">str</span>