Совместимость
Какие версии терминала, API и клиентов работают вместе и что остаётся неизменным внутри v1.
У терминала, у API и у клиентских пакетов свои версии.
Проверить версии
meta = terminal.meta()
print(meta.app_version, meta.api_version)app_version — версия терминала, например 2.0.0.
api_version — версия API: 1 для всех адресов под /v1.
discover() проверяет версию API за вас. Если клиент её не поддерживает,
discover() выбрасывает IncompatibleTerminal в Python и
IncompatibleTerminalError в TypeScript.
Какие версии работают вместе
| Клиент | API | Терминал |
|---|---|---|
| 0.1.x | v1 | Первый релиз с Local API и все последующие |
Терминал новее клиента работает всегда. Клиент новее терминала тоже
работает. Метод, которого в терминале ещё нет, отвечает not_found.
Что обещает v1
Внутри v1 API только растёт. Поля, коды ошибок, топики и операции могут добавляться. Существующие остаются и сохраняют свой тип.
Игнорируйте незнакомые поля, и более новый терминал не сломает вашу программу. Клиенты уже так делают.
Форма меняется только с новой версией API, /v2.