Покрытие кода docstrings
This commit is contained in:
parent
4e92aba2a2
commit
8f48df2cf5
19 changed files with 2324 additions and 1839 deletions
|
|
@ -1,3 +1,27 @@
|
|||
"""
|
||||
Маршрутизация API-версии v1 для GONETS.
|
||||
|
||||
Модуль агрегирует и монтирует роутеры отдельных доменных областей под общим
|
||||
корневым роутером. Каждый подключенный модуль предоставляет набор эндпоинтов
|
||||
со своим префиксом и тегами для группировки в документации FastAPI.
|
||||
|
||||
Структура маршрутов:
|
||||
- `/ufw` (UFW): управление правилами и состоянием Uncomplicated Firewall.
|
||||
- `/ip` (IP): проверки и применение IP-конфигураций для сетевых профилей.
|
||||
- `/network` (Network): получение и визуализация состояния интерфейсов,
|
||||
управление позициями UI-контейнеров.
|
||||
- `/auth` (Auth): регистрация, аутентификация (JWT), сессии.
|
||||
- `/subnet` (Subnet): сканирование подсетей, заметки к устройствам,
|
||||
взаимодействие с Wi‑Fi (скан/подключение/отключение/статус).
|
||||
- `WebSocket`: обработчики взаимодействия по WS (без префикса, путь внутри
|
||||
модуля), периодическая трансляция сетевых данных.
|
||||
- `/settings` (Settings): сервисные операции над локальными JSON‑хранилищами
|
||||
(очистка данных подсетей/wi‑fi и пр.).
|
||||
|
||||
Назначение:
|
||||
- Централизованная точка подключения доменных роутеров к приложению.
|
||||
- Единообразие тегов и префиксов для автогенерации схемы и документации.
|
||||
"""
|
||||
from fastapi import APIRouter
|
||||
from .v1 import ufw, websocket, ip, network, auth, subnet, settings
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue