Политика устаревания

Со временем часть API Диадока устаревает и заменяется новыми, более функциональными версиями. В связи с этим мы вынуждены удалять неактуальные методы и структуры без сохранения обратной совместимости спустя период устаревания.

Примечание

Период устаревания — промежуток времени между оповещением пользователей об удалении части API до его безвозвратного удаления.

Период устаревания для плановых изменений составляет 6 месяцев. Однако в некоторых ситуациях он может быть меньше:

  • если в части API обнаружены проблемы с безопасностью, которые требуют немедленного устранения;

  • если в законодательстве произошли изменения, которые требуют отказа от части функциональности API.

В этих случаях период устаревания сокращается до срока, необходимого для внесения изменений.

Если мы планируем внести изменение, которое ломает обратную совместимость, мы обязуемся:

  • опубликовать информацию об удалении на странице История изменений не позднее, чем за время периода устаревания, и указать дату, после которой планируется удаление части API;

  • опубликовать инструкцию по миграции на актуальные версии, если они существуют;

  • отметить в документации устаревшие методы и структуры и указать дату, после которой планируется их удаление из API.

В течение периода устаревания мы:

  • не развиваем устаревшую функциональность, не добавляем в нее новые возможности;

  • выключаем устаревшую функциональность на тестовой инсталляции API;

  • исправляем в устаревших частях API только критичные проблемы, в том числе проблемы с информационной безопасностью;

  • возвращаем в устаревших методах HTTP-заголовки Sunset и Link с дополнительной информацией о планируемом выключении, например:

    Sunset: Wed, 11 Nov 2026 11:11:11 GMT
    Link: <https://api-docs.diadoc.ru/howtostart/deprecationPolicy.html>;rel="sunset";type="text/html"
    

После этой даты устаревшие методы и структуры могут быть безвозвратно удалены.

Перечень методов и структур, которые запланированы к удалению из API, приведены на странице Удаляемые методы и структуры.