Repair docs (html, md). Update docstrings

SRV/models/auth.py

@@ -3,13 +3,13 @@ from typing import Optional
 
 
 class UserCreate(BaseModel):
-    """
-    Модель созданного пользователя
+    """Модель созданного пользователя.
 
     Атрибуты:
-        username (str): Имя пользователя
-        password (str): Пароль пользователя
-        is_admin (bool): Административный доступ
+
+    - ``username`` (str): Имя пользователя.
+    - ``password`` (str): Пароль пользователя.
+    - ``is_admin`` (bool): Флаг административного доступа.
     """
 
     username: str
@@ -18,12 +18,12 @@ class UserCreate(BaseModel):
 
 
 class UserLogin(BaseModel):
-    """
-    Модель авторизации пользователя
+    """Модель авторизации пользователя.
 
     Атрибуты:
-        username (str): Имя пользователя
-        password (str): Пароль пользователя
+
+    - ``username`` (str): Имя пользователя.
+    - ``password`` (str): Пароль пользователя.
     """
 
     username: str
@@ -31,13 +31,13 @@ class UserLogin(BaseModel):
 
 
 class UserResponse(BaseModel):
-    """
-    Модель проверки наличия пользователя
+    """Модель, используемая при возврате сведений о пользователе.
 
     Атрибуты:
-        id (int): Идентификатор
-        username (str): Имя пользователя
-        is_admin (bool): Административный доступ
+
+    - ``id`` (int): Идентификатор пользователя.
+    - ``username`` (str): Имя пользователя.
+    - ``is_admin`` (bool): Флаг административного доступа.
     """
 
     id: int
@@ -46,14 +46,14 @@ class UserResponse(BaseModel):
 
 
 class Token(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

SRV/models/network.py

@@ -3,14 +3,14 @@ from pydantic import BaseModel
 
 
 class IPv4Route(BaseModel):
-    """
-    Модель маршрута IPv4
+    """Модель маршрута IPv4.
 
     Атрибуты:
-        destination (str): IP-адрес назначения
-        prefix (int): Префикс подсети в формате CIDR
-        next_hop (str): Адрес следующего узла (маршрутизатор)
-        metric (int): Метрика маршрута
+
+    - ``destination`` (str): IP-адрес назначения.
+    - ``prefix`` (int): Префикс подсети в формате CIDR.
+    - ``next_hop`` (str): Адрес следующего узла (маршрутизатор).
+    - ``metric`` (int): Метрика маршрута.
     """
 
     destination: str
@@ -20,14 +20,14 @@ class IPv4Route(BaseModel):
 
 
 class IPv6Route(BaseModel):
-    """
-    Модель маршрута IPv6
+    """Модель маршрута IPv6.
 
     Атрибуты:
-        destination (str): IP-адрес назначения
-        prefix (int): Префикс подсети (CIDR)
-        next_hop (str): Адрес следующего узла (маршрутизатор)
-        metric (int): Метрика маршрута
+
+    - ``destination`` (str): IP-адрес назначения.
+    - ``prefix`` (int): Префикс подсети в формате CIDR.
+    - ``next_hop`` (str): Адрес следующего узла.
+    - ``metric`` (int): Метрика маршрута.
     """
 
     destination: str
@@ -37,15 +37,15 @@ class IPv6Route(BaseModel):
 
 
 class IndividualIPConfig(BaseModel):
-    """
-    Модель индивидуальной конфигурации IP-адреса
+    """Модель индивидуальной конфигурации IP-адреса.
 
     Атрибуты:
-        address (str): IP-адрес интерфейса
-        routes (List[Union[IPv4Route, IPv6Route]]): Список маршрутов (IPv4/IPv6)
-        method (Optional[str]): Метод назначения IP
-        gateway (str): Основной шлюз по умолчанию
-        dns (List[str]): Список DNS-серверов
+
+    - ``address`` (str): IP-адрес интерфейса.
+    - ``routes`` (List[Union[IPv4Route, IPv6Route]]): Список маршрутов.
+    - ``method`` (Optional[str]): Метод назначения IP.
+    - ``gateway`` (str): Шлюз по умолчанию.
+    - ``dns`` (List[str]): Список DNS-серверов.
     """
 
     address: str
@@ -56,31 +56,31 @@ class IndividualIPConfig(BaseModel):
 
 
 class IPConfig(BaseModel):
-    """
-    Модель конфигурации IP (IPv4/IPv6)
+    """Групповая конфигурация IP-адресов.
 
     Атрибуты:
-        configurations (List[IndividualIPConfig]): Список индивидуальных IP-конфигураций
+
+    - ``configurations`` (List[IndividualIPConfig]): Индивидуальные IP-конфигурации.
     """
 
     configurations: List[IndividualIPConfig]
 
 
 class NetworkInterface(BaseModel):
-    """
-    Модель базового сетевого интерфейса
+    """Модель базового сетевого интерфейса.
 
     Атрибуты:
-        name (str): Название интерфейса
-        type (str): Тип интерфейса
-        mac_address (str): MAC-адрес устройства
-        device_state (str): Состояние устройства
-        active_connection (str): Название активного соединения
-        device_mtu (str): MTU устройства
-        ipv4 (IPConfig): Конфигурация IPv4
-        ipv6 (IPConfig): Конфигурация IPv6
-        container_x (int): Положение по X на холсте
-        container_y (int): Положение по Y на холсте
+
+    - ``name`` (str): Название интерфейса.
+    - ``type`` (str): Тип устройства.
+    - ``mac_address`` (str): MAC-адрес.
+    - ``device_state`` (str): Текущее состояние.
+    - ``active_connection`` (str): Название активного соединения.
+    - ``device_mtu`` (str): MTU устройства.
+    - ``ipv4`` (IPConfig): IPv4-конфигурация.
+    - ``ipv6`` (IPConfig): IPv6-конфигурация.
+    - ``container_x`` (int): Положение по оси X на холсте.
+    - ``container_y`` (int): Положение по оси Y на холсте.
     """
 
     name: str
@@ -96,16 +96,16 @@ class NetworkInterface(BaseModel):
 
 
 class WiFiDevice(NetworkInterface):
-    """
-    Модель Wi-Fi устройства (наследуется от NetworkInterface)
+    """Расширенная модель Wi-Fi устройства.
 
     Атрибуты:
-        ssid (Optional[str]): Название Wi-Fi сети
-        bssid (Optional[str]): MAC-адрес точки доступа
-        bitrate (Optional[int]): Скорость соединения
-        strength (Optional[int]): Уровень сигнала
-        frequency (Optional[float]): Частота
-        mode (Union[str, int]): Режим работы
+
+    - ``ssid`` (Optional[str]): Название Wi-Fi сети.
+    - ``bssid`` (Optional[str]): MAC-адрес точки доступа.
+    - ``bitrate`` (Optional[int]): Скорость соединения.
+    - ``strength`` (Optional[int]): Уровень сигнала.
+    - ``frequency`` (Optional[float]): Рабочая частота.
+    - ``mode`` (Union[str, int]): Режим работы.
     """
 
     ssid: Optional[str] = None
@@ -117,13 +117,13 @@ class WiFiDevice(NetworkInterface):
 
 
 class NetworkInterfacesContainer(BaseModel):
-    """
-    Контейнер для группы сетевых интерфейсов с координатами
+    """Контейнер для набора сетевых интерфейсов.
 
     Атрибуты:
-        interfaces (List[Union[NetworkInterface, WiFiDevice]]): Список интерфейсов
-        container_x (int): Положение по оси X
-        container_y (int): Положение по оси Y
+
+    - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Список интерфейсов.
+    - ``container_x`` (int): Положение по оси X.
+    - ``container_y`` (int): Положение по оси Y.
     """
 
     interfaces: List[Union[NetworkInterface, WiFiDevice]]
@@ -132,15 +132,15 @@ class NetworkInterfacesContainer(BaseModel):
 
 
 class Activation(BaseModel):
-    """
-    Модель активированных интерфейсов
+    """Модель узла активных интерфейсов.
 
     Атрибуты:
-        id (int): Идентификатор ноды активированных интерфейсов
-        interfaces (List[Union[NetworkInterface, WiFiDevice]]): Активированные интерфейсы
-        container_x (int): Положение по X на холсте
-        container_y (int): Положение по Y на холсте
-        isOpen (bool): Флаг скрытия ноды на холсте
+
+    - ``id`` (int): Идентификатор ноды.
+    - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Активные интерфейсы.
+    - ``container_x`` (int): Координата X на холсте.
+    - ``container_y`` (int): Координата Y на холсте.
+    - ``isOpen`` (bool): Флаг отображения узла на холсте.
     """
 
     id: int
@@ -151,15 +151,15 @@ class Activation(BaseModel):
 
 
 class Deactivation(BaseModel):
-    """
-    Модель отключенных интерфейсов
+    """Модель узла отключённых интерфейсов.
 
     Атрибуты:
-        id (int): Идентификатор ноды отключенных интерфейсов
-        interfaces (List[Union[NetworkInterface, WiFiDevice]]): Отключенные интерфейсы
-        container_x (int): Положение по X на холсте
-        container_y (int): Положение по Y на холсте
-        isOpen (bool): Флаг скрытия ноды на холсте
+
+    - ``id`` (int): Идентификатор ноды.
+    - ``interfaces`` (List[Union[NetworkInterface, WiFiDevice]]): Список отключённых интерфейсов.
+    - ``container_x`` (int): Координата X на холсте.
+    - ``container_y`` (int): Координата Y на холсте.
+    - ``isOpen`` (bool): Флаг отображения узла на холсте.
     """
 
     id: int

SRV/models/request.py

@@ -2,31 +2,31 @@ from pydantic import BaseModel
 
 
 class NoteRequest(BaseModel):
-    """
-    Модель добавления заметки к просканированному устройству
+    """Модель запроса на добавление заметки к устройству.
 
     Атрибуты:
-        note (str): Заметка устройства
+
+    - ``note`` (str): Текст заметки.
     """
 
     note: str
 
 class WifiConnectRequest(BaseModel):
-    """
-    Модель для подключения к точке доступа Wi-Fi
+    """Модель запроса на подключение к Wi-Fi.
 
     Атрибуты:
-        ssid (str): Название точки доступа Wi-Fi
-        password (str): Пароль точки доступа Wi-Fi
+
+    - ``ssid`` (str): Название точки доступа.
+    - ``password`` (str): Пароль доступа.
     """
     ssid: str
     password: str
 
 class WifiDisconnectRequest(BaseModel):
-    """
-    Модель для отключения от точки доступа Wi-Fi
+    """Модель запроса на отключение от Wi-Fi.
 
     Атрибуты:
-        ssid (str): Название точки доступа Wi-Fi
+
+    - ``ssid`` (str): Название точки доступа.
     """
-    ssid: str
+    ssid: str

SRV/models/subnet.py

@@ -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

SRV/models/wifi.py

@@ -3,19 +3,19 @@ from typing import Optional, List
 
 
 class WifiAccessPoint(BaseModel):
-    """
-    Модель точки доступа Wi-Fi
+    """Модель Wi-Fi точки доступа.
 
     Атрибуты:
-        ssid (Optional[str]): Название точки доступа. Может быть скрытым
-        bssid (str): Уникальный идентификатор точки доступа (по типу MAC-адреса)
-        channel (Optional[int]): Канал, на котором работает точка доступа
-        signal (Optional[int]): Уровень сигнала (dBm)
-        encryption (Optional[str]): Тип шифрования (WPA2, WPA3, открытая и т.д.)
-        frequency (Optional[str]): Частота вещания (2.4GHz/5GHz)
-        vendor (Optional[str]): Производитель точки доступа (определяется по MAC-адресу)
-        hidden (bool): Флаг скрытия названия точки доступа (ssid)
-        note (Optional[str]): Заметка для точки доступа
+
+    - ``ssid`` (Optional[str]): Название сети (может быть скрытым).
+    - ``bssid`` (str): Уникальный идентификатор точки доступа.
+    - ``channel`` (Optional[int]): Номер канала.
+    - ``signal`` (Optional[int]): Уровень сигнала в dBm.
+    - ``encryption`` (Optional[str]): Тип шифрования (WPA/WPA2/WPA3/открытая).
+    - ``frequency`` (Optional[str]): Диапазон частот (2.4/5 ГГц).
+    - ``vendor`` (Optional[str]): Производитель оборудования.
+    - ``hidden`` (bool): Флаг скрытого SSID.
+    - ``note`` (Optional[str]): Пользовательская заметка.
     """
 
     ssid: Optional[str] = None
@@ -30,11 +30,11 @@ class WifiAccessPoint(BaseModel):
 
 
 class WifiScanResult(BaseModel):
-    """
-    Результат сканирования Wi-Fi
+    """Результат сканирования Wi-Fi.
 
     Атрибуты:
-        access_points (List[WifiAccessPoint]): Список найденных Wi-Fi точек доступа
+
+    - ``access_points`` (List[WifiAccessPoint]): Найденные точки доступа.
     """
 
-    access_points: List[WifiAccessPoint]
+    access_points: List[WifiAccessPoint]