Repair docs (html, md). Update docstrings
This commit is contained in:
parent
e264750187
commit
6a4ad48577
125 changed files with 3706 additions and 4913 deletions
|
|
@ -2,18 +2,18 @@ from pydantic import BaseModel
|
|||
from typing import Optional, List
|
||||
|
||||
class Device(BaseModel):
|
||||
"""
|
||||
Сканируемое устройство в подсети
|
||||
"""Модель устройства, обнаруженного в подсети.
|
||||
|
||||
Атрибуты:
|
||||
ip (str): IP-адрес устройства
|
||||
mac (Optional[str]): MAC-адрес устройства
|
||||
hostname (Optional[str]): Имя хоста
|
||||
vendor (Optional[str]): Название производителя устройства (По MAC-адресу)
|
||||
open_ports (List[str]): Открытые порты устройства
|
||||
status (str): Статус устройства (онлайн/оффлайн)
|
||||
last_seen (Optional[str]): Последняя активность устройства
|
||||
note (Optional[str]): Заметка устройства
|
||||
|
||||
- ``ip`` (str): IP-адрес устройства.
|
||||
- ``mac`` (Optional[str]): MAC-адрес устройства.
|
||||
- ``hostname`` (Optional[str]): Имя хоста.
|
||||
- ``vendor`` (Optional[str]): Производитель оборудования.
|
||||
- ``open_ports`` (List[str]): Открытые порты.
|
||||
- ``status`` (str): Состояние устройства (online/offline).
|
||||
- ``last_seen`` (Optional[str]): Время последнего обнаружения.
|
||||
- ``note`` (Optional[str]): Пользовательская заметка.
|
||||
"""
|
||||
|
||||
ip: str
|
||||
|
|
@ -26,22 +26,22 @@ class Device(BaseModel):
|
|||
note: Optional[str] = None
|
||||
|
||||
class SubnetScanResult(BaseModel):
|
||||
"""
|
||||
Результат сканирования устройств в подсети
|
||||
"""Результат сканирования подсети.
|
||||
|
||||
Атрибуты:
|
||||
devices (List[Device]): Список просканированных устройств
|
||||
error (Optional[str]): Сообщение об ошибке, если сканирование не удалось
|
||||
|
||||
- ``devices`` (List[Device]): Найденные устройства.
|
||||
- ``error`` (Optional[str]): Сообщение об ошибке сканирования.
|
||||
"""
|
||||
|
||||
devices: List[Device] = []
|
||||
error: Optional[str] = None
|
||||
|
||||
class SubnetScanRequest(BaseModel):
|
||||
"""
|
||||
Параметры для сканирования подсети
|
||||
"""Параметры запроса на сканирование подсети.
|
||||
|
||||
Атрибуты:
|
||||
subnet (Optional[str]): Подсеть для сканирования (например 192.168.1.0/24), опционально
|
||||
|
||||
- ``subnet`` (Optional[str]): CIDR подсети (например, ``192.168.1.0/24``).
|
||||
"""
|
||||
subnet: Optional[str] = None
|
||||
subnet: Optional[str] = None
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue