Repair docs (html, md). Update docstrings

2025-10-21 10:51:32 +05:00 · 2025-10-21 10:51:32 +05:00 · 6a4ad48577
commit 6a4ad48577
parent e264750187
125 changed files with 3706 additions and 4913 deletions
--- a/SRV/docs/_build/html/api/endpoints/ip.html
+++ b/SRV/docs/_build/html/api/endpoints/ip.html
@ -172,7 +172,7 @@
          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
        </button>
      </div>
-      <label class="toc-overlay-icon toc-header-icon" for="__toc">
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
        <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
      </label>
    </div>
@ -276,93 +276,110 @@
              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
            </button>
          </div>
-          <label class="toc-overlay-icon toc-content-icon" for="__toc">
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
            <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
          </label>
        </div>
        <article role="main" id="furo-main-content">
-          <section id="module-api.v1.ip">
-<span id="api-v1-ip"></span><h1>api.v1.ip<a class="headerlink" href="#module-api.v1.ip" title="Link to this heading">¶</a></h1>
+          <section id="api-v1-ip">
+<h1>api.v1.ip<a class="headerlink" href="#api-v1-ip" title="Link to this heading">¶</a></h1>
 <dl class="py function">
-<dt class="sig sig-object py" id="api.v1.ip.apply_ip_config">
-<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ip.</span></span><span class="sig-name descname"><span class="pre">apply_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Body(PydanticUndefined)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Depends(translations_dependency)</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ip.html#apply_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ip.apply_ip_config" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ip.</span></span><span class="sig-name descname"><span class="pre">apply_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Body(PydanticUndefined)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Depends(translations_dependency)</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ip.html#apply_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Применяет проверенные IP-настройки к указанному сетевому профилю.</p>
 <p>Обновляет настройки соединения через NetworkManager, отключает и
 переподключает устройство к сети.</p>
-<dl>
-<dt>Args:</dt><dd><dl class="simple">
-<dt>data (Dict[str, Any]): Словарь с данными конфигурации, включая</dt><dd><p>“connection_id” и “ipv4_updates” с обновлениями IP-настроек.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>data</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – Словарь с данными конфигурации, включая
+“connection_id” и “ipv4_updates” с обновлениями IP-настроек.</p></li>
+<li><p><strong>translations</strong> – Объект переводов для текущего языка.</p></li>
+</ul>
 </dd>
-</dl>
-<p>translations: Объект переводов для текущего языка.</p>
-</dd>
-<dt>Returns:</dt><dd><dl class="simple">
-<dt>dict: Словарь с ключами:</dt><dd><ul class="simple">
-<li><p>“success” (bool): Успешность операции.</p></li>
-<li><p>“message” (str): Сообщение об успешном применении настроек.</p></li>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><dl class="simple">
+<dt>Словарь с ключами:</dt><dd><ul class="simple">
+<li><p>”success” (bool): Успешность операции.</p></li>
+<li><p>”message” (str): Сообщение об успешном применении настроек.</p></li>
 </ul>
 </dd>
 </dl>
+</p>
 </dd>
-<dt>Raises:</dt><dd><dl class="simple">
-<dt>HTTPException: Если подключение не найдено (status_code=404) или</dt><dd><p>произошла внутренняя ошибка (status_code=500).</p>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>dict</p>
 </dd>
-</dl>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>HTTPException</strong> – Если подключение не найдено (status_code=404) или
+    произошла внутренняя ошибка (status_code=500).</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py function">
-<dt class="sig sig-object py" id="api.v1.ip.check_ip_config">
-<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ip.</span></span><span class="sig-name descname"><span class="pre">check_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Body(PydanticUndefined)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Depends(translations_dependency)</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ip.html#check_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ip.check_ip_config" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ip.</span></span><span class="sig-name descname"><span class="pre">check_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Body(PydanticUndefined)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Depends(translations_dependency)</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ip.html#check_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Проверяет доступность IP-адреса перед его применением.</p>
 <p>Выполняет ARP-сканирование для проверки, занят ли указанный IP-адрес,
 и возвращает результат проверки.</p>
-<dl>
-<dt>Args:</dt><dd><dl class="simple">
-<dt>data (Dict[str, Any]): Словарь с данными конфигурации, включая</dt><dd><p>“ipv4_updates” с полем “ipv4.address-data” для нового IP-адреса.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>data</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – Словарь с данными конфигурации, включая
+“ipv4_updates” с полем “ipv4.address-data” для нового IP-адреса.</p></li>
+<li><p><strong>translations</strong> – Объект переводов для текущего языка.</p></li>
+</ul>
 </dd>
-</dl>
-<p>translations: Объект переводов для текущего языка.</p>
-</dd>
-<dt>Returns:</dt><dd><dl class="simple">
-<dt>Dict[str, Any]: Словарь с ключами:</dt><dd><ul class="simple">
-<li><p>“available” (bool): Доступен ли IP-адрес.</p></li>
-<li><p>“message” (str): Сообщение о результате проверки.</p></li>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><dl class="simple">
+<dt>Словарь с ключами:</dt><dd><ul class="simple">
+<li><p>”available” (bool): Доступен ли IP-адрес.</p></li>
+<li><p>”message” (str): Сообщение о результате проверки.</p></li>
 </ul>
 </dd>
 </dl>
+</p>
 </dd>
-<dt>Raises:</dt><dd><p>HTTPException: Если произошла внутренняя ошибка (status_code=500).</p>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>Dict[str, Any]</p>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>HTTPException</strong> – Если произошла внутренняя ошибка (status_code=500).</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py function">
-<dt class="sig sig-object py" id="api.v1.ip.save_ip_config">
-<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ip.</span></span><span class="sig-name descname"><span class="pre">save_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Body(PydanticUndefined)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Depends(translations_dependency)</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ip.html#save_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#api.v1.ip.save_ip_config" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">api.v1.ip.</span></span><span class="sig-name descname"><span class="pre">save_ip_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Body(PydanticUndefined)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Translations</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">Depends(translations_dependency)</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/api/v1/ip.html#save_ip_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Применяет проверенные IP-настройки для отката сетевого профиля.</p>
 <p>Используется для сохранения и отката настроек сетевого профиля к предыдущему
 состоянию через NetworkManager.</p>
-<dl>
-<dt>Args:</dt><dd><dl class="simple">
-<dt>data (Dict[str, Any]): Словарь с данными конфигурации, включая</dt><dd><p>“connection_id” и “ipv4_updates” с обновлениями IP-настроек.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>data</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – Словарь с данными конфигурации, включая
+“connection_id” и “ipv4_updates” с обновлениями IP-настроек.</p></li>
+<li><p><strong>translations</strong> – Объект переводов для текущего языка.</p></li>
+</ul>
 </dd>
-</dl>
-<p>translations: Объект переводов для текущего языка.</p>
-</dd>
-<dt>Returns:</dt><dd><dl class="simple">
-<dt>dict: Словарь с ключами:</dt><dd><ul class="simple">
-<li><p>“success” (bool): Успешность операции.</p></li>
-<li><p>“message” (str): Сообщение об успешном применении настроек.</p></li>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><dl class="simple">
+<dt>Словарь с ключами:</dt><dd><ul class="simple">
+<li><p>”success” (bool): Успешность операции.</p></li>
+<li><p>”message” (str): Сообщение об успешном применении настроек.</p></li>
 </ul>
 </dd>
 </dl>
+</p>
 </dd>
-<dt>Raises:</dt><dd><dl class="simple">
-<dt>HTTPException: Если подключение не найдено (status_code=404) или</dt><dd><p>произошла внутренняя ошибка (status_code=500).</p>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>dict</p>
 </dd>
-</dl>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>HTTPException</strong> – Если подключение не найдено (status_code=404) или
+    произошла внутренняя ошибка (status_code=500).</p>
 </dd>
 </dl>
 </dd></dl>
@ -412,30 +429,9 @@
        
      </footer>
    </div>
-    <aside class="toc-drawer">
+    <aside class="toc-drawer no-toc">
      
      
-      <div class="toc-sticky toc-scroll">
-        <div class="toc-title-container">
-          <span class="toc-title">
-            On this page
-          </span>
-        </div>
-        <div class="toc-tree-container">
-          <div class="toc-tree">
-            <ul>
-<li><a class="reference internal" href="#">api.v1.ip</a><ul>
-<li><a class="reference internal" href="#api.v1.ip.apply_ip_config"><code class="docutils literal notranslate"><span class="pre">apply_ip_config()</span></code></a></li>
-<li><a class="reference internal" href="#api.v1.ip.check_ip_config"><code class="docutils literal notranslate"><span class="pre">check_ip_config()</span></code></a></li>
-<li><a class="reference internal" href="#api.v1.ip.save_ip_config"><code class="docutils literal notranslate"><span class="pre">save_ip_config()</span></code></a></li>
-</ul>
-</li>
-</ul>
-
-          </div>
-        </div>
-      </div>
-      
      
    </aside>
  </div>