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

@ -281,18 +281,18 @@
<div class="viewcode-block" id="Device">
<a class="viewcode-back" href="../../api/models/subnet.html#models.subnet.Device">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Device</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"> ip (str): IP-адрес устройства</span>
<span class="sd"> mac (Optional[str]): MAC-адрес устройства</span>
<span class="sd"> hostname (Optional[str]): Имя хоста</span>
<span class="sd"> vendor (Optional[str]): Название производителя устройства (По MAC-адресу)</span>
<span class="sd"> open_ports (List[str]): Открытые порты устройства</span>
<span class="sd"> status (str): Статус устройства (онлайн/оффлайн)</span>
<span class="sd"> last_seen (Optional[str]): Последняя активность устройства</span>
<span class="sd"> note (Optional[str]): Заметка устройства</span>
<span class="sd"> - ``ip`` (str): IP-адрес устройства.</span>
<span class="sd"> - ``mac`` (Optional[str]): MAC-адрес устройства.</span>
<span class="sd"> - ``hostname`` (Optional[str]): Имя хоста.</span>
<span class="sd"> - ``vendor`` (Optional[str]): Производитель оборудования.</span>
<span class="sd"> - ``open_ports`` (List[str]): Открытые порты.</span>
<span class="sd"> - ``status`` (str): Состояние устройства (online/offline).</span>
<span class="sd"> - ``last_seen`` (Optional[str]): Время последнего обнаружения.</span>
<span class="sd"> - ``note`` (Optional[str]): Пользовательская заметка.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">ip</span><span class="p">:</span> <span class="nb">str</span>
@ -308,12 +308,12 @@
<div class="viewcode-block" id="SubnetScanResult">
<a class="viewcode-back" href="../../api/models/subnet.html#models.subnet.SubnetScanResult">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">SubnetScanResult</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"> devices (List[Device]): Список просканированных устройств</span>
<span class="sd"> error (Optional[str]): Сообщение об ошибке, если сканирование не удалось</span>
<span class="sd"> - ``devices`` (List[Device]): Найденные устройства.</span>
<span class="sd"> - ``error`` (Optional[str]): Сообщение об ошибке сканирования.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">devices</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Device</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
@ -323,11 +323,11 @@
<div class="viewcode-block" id="SubnetScanRequest">
<a class="viewcode-back" href="../../api/models/subnet.html#models.subnet.SubnetScanRequest">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">SubnetScanRequest</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"> subnet (Optional[str]): Подсеть для сканирования (например 192.168.1.0/24), опционально</span>
<span class="sd"> - ``subnet`` (Optional[str]): CIDR подсети (например, ``192.168.1.0/24``).</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">subnet</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span></div>