Files
omnichannel-configserver-mcp/docs/api-compatibility.md
T

48 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Совместимость с версиями API
`omnichannel-configserver-mcp` рассчитан на API **`config_server` 1.1.0** (он же `latest`).
Эта версия добавила JSON-эндпоинты, на которые опирается сервер.
## Что появилось в 1.1.0
| Эндпоинт | Назначение |
|---|---|
| `POST /api/login`, `POST /api/logout` | JSON-авторизация для сторонних клиентов |
| `GET /api/whoami` | Проверка сессии |
| `GET /api/application/<id>` | Детализация сервиса в JSON |
| `POST /api/compose/<id>` | Установка compose через JSON |
| `POST /api/env/<id>/<file>` | Установка env через JSON |
| `GET /api/tasks`, `GET /api/task/<id>` | Список/статус задач |
В более старых версиях (≤ 1.0.20) этих эндпоинтов нет: логин был только
HTML-формой, конфиг правился HTML-страницами, а список задач — только по хосту.
`update_front` появился раньше (1.0.19+).
## Capability-probe
Инструмент `server_info` определяет версию автоматически (по доступности
`GET /api/whoami`) и возвращает:
```json
{
"server": "prod",
"base_url": "http://10.20.30.40:5005",
"read_only": false,
"capabilities": {
"version": "1.1.0",
"features": { "api_login": true, "set_compose": true, "tasks_filter": true, … }
}
}
```
На старом стенде `version` будет `legacy (<1.1.0)`, а `features` — пустым. В этом
случае инструменты, требующие новых эндпоинтов, вернут понятное сообщение вместо
«тихой» поломки. Наблюдение и часть операций на старых версиях недоступны —
обновите `config_server`.
## Рекомендация
Перед автоматизацией вызовите `server_info` и убедитесь, что `version` = `1.1.0`.
Если планируется смешанный парк — запускайте отдельный инстанс модуля на каждый
контур со своим `server`-конфигом.