Generate Sphinx docs in markdown
This commit is contained in:
parent
bc4e9caacb
commit
81ff7959f7
84 changed files with 2873 additions and 29 deletions
63
SRV/docs/_build/markdown/api/endpoints/ip.md
vendored
Normal file
63
SRV/docs/_build/markdown/api/endpoints/ip.md
vendored
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
# api.v1.ip
|
||||
|
||||
### *async* api.v1.ip.apply_ip_config(data: Dict[str, Any] = Body(PydanticUndefined), translations: Translations = Depends(translations_dependency))
|
||||
|
||||
Применяет проверенные IP-настройки к указанному сетевому профилю.
|
||||
|
||||
Обновляет настройки соединения через NetworkManager, отключает и
|
||||
переподключает устройство к сети.
|
||||
|
||||
* **Parameters:**
|
||||
* **data** (*Dict* *[**str* *,* *Any* *]*) – Словарь с данными конфигурации, включая
|
||||
“connection_id” и “ipv4_updates” с обновлениями IP-настроек.
|
||||
* **translations** – Объект переводов для текущего языка.
|
||||
* **Returns:**
|
||||
Словарь с ключами:
|
||||
: - ”success” (bool): Успешность операции.
|
||||
- ”message” (str): Сообщение об успешном применении настроек.
|
||||
* **Return type:**
|
||||
dict
|
||||
* **Raises:**
|
||||
**HTTPException** – Если подключение не найдено (status_code=404) или
|
||||
произошла внутренняя ошибка (status_code=500).
|
||||
|
||||
### *async* api.v1.ip.check_ip_config(data: Dict[str, Any] = Body(PydanticUndefined), translations: Translations = Depends(translations_dependency))
|
||||
|
||||
Проверяет доступность IP-адреса перед его применением.
|
||||
|
||||
Выполняет ARP-сканирование для проверки, занят ли указанный IP-адрес,
|
||||
и возвращает результат проверки.
|
||||
|
||||
* **Parameters:**
|
||||
* **data** (*Dict* *[**str* *,* *Any* *]*) – Словарь с данными конфигурации, включая
|
||||
“ipv4_updates” с полем “ipv4.address-data” для нового IP-адреса.
|
||||
* **translations** – Объект переводов для текущего языка.
|
||||
* **Returns:**
|
||||
Словарь с ключами:
|
||||
: - ”available” (bool): Доступен ли IP-адрес.
|
||||
- ”message” (str): Сообщение о результате проверки.
|
||||
* **Return type:**
|
||||
Dict[str, Any]
|
||||
* **Raises:**
|
||||
**HTTPException** – Если произошла внутренняя ошибка (status_code=500).
|
||||
|
||||
### *async* api.v1.ip.save_ip_config(data: Dict[str, Any] = Body(PydanticUndefined), translations: Translations = Depends(translations_dependency))
|
||||
|
||||
Применяет проверенные IP-настройки для отката сетевого профиля.
|
||||
|
||||
Используется для сохранения и отката настроек сетевого профиля к предыдущему
|
||||
состоянию через NetworkManager.
|
||||
|
||||
* **Parameters:**
|
||||
* **data** (*Dict* *[**str* *,* *Any* *]*) – Словарь с данными конфигурации, включая
|
||||
“connection_id” и “ipv4_updates” с обновлениями IP-настроек.
|
||||
* **translations** – Объект переводов для текущего языка.
|
||||
* **Returns:**
|
||||
Словарь с ключами:
|
||||
: - ”success” (bool): Успешность операции.
|
||||
- ”message” (str): Сообщение об успешном применении настроек.
|
||||
* **Return type:**
|
||||
dict
|
||||
* **Raises:**
|
||||
**HTTPException** – Если подключение не найдено (status_code=404) или
|
||||
произошла внутренняя ошибка (status_code=500).
|
||||
Loading…
Add table
Add a link
Reference in a new issue