Необходимые cookie-файлы нужны для работы сайта. Аналитические cookie (Яндекс Метрика) — только с вашего согласия. Политика cookie-файлов

Тема оформления
Объяснения

Версии

Версионирование типизаторов и версионирование самого API: что считается ломающим изменением.

Версии типизатора (схемы)

Каждое сохранение схемы типизатора создаёт новую неизменяемую версию — прежние версии не меняются и не удаляются. Прогон запоминает, с какой версией схемы он выполнялся: изменение схемы типизатора не меняет задним числом уже выполненные прогоны и их результаты.

Прогон можно запустить по последней версии типизатора или явно указать номер версии — это полезно, если нужно повторить документ с той же схемой, что и раньше.

Версионирование API: /v1

Версия API — в пути: /v1. Пока используется /v1, обратная совместимость сохраняется: новые необязательные поля и операции могут появляться без предупреждения, но существующие поля не меняют смысл и не удаляются.

Ломающие изменения выходят только в /v2

Изменения, ломающие обратную совместимость — переименование или удаление поля, смена типа значения, смена смысла существующего кода ответа, — выходят только в новой версии пути, /v2, и никогда не вносятся в /v1 задним числом. /v1 продолжает работать и после выхода /v2.