Сумісність
Які версії термінала, 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.