Перейти к содержанию

Версионирование CloudPrint API

Правила совместимости v1, допустимые дополнения, выпуск несовместимых версий, уведомления об устаревании и миграции.

Основная версия в URL

CloudPrint закрепляет границу совместимости в /api/v1; документация использует /docs/api/v1/. Версии приложения вроде 0.7.1 не являются версиями API.

Совместимые изменения v1

В v1 могут добавляться методы, необязательные поля запроса, поля ответа, допустимые значения и промежуточные статусы. Клиент должен игнорировать неизвестные поля ответа и корректно обрабатывать новые неконечные статусы.

Несовместимые изменения

Удаление или переименование операции или поля, добавление обязательного поля, изменение типа или требований авторизации требует новой основной версии и руководства по миграции.

Устаревание версии

О предстоящем выводе версии сообщается в истории изменений API и руководстве по миграции. Когда применимо, ответы заранее получают стандартные заголовки Deprecation и Sunset.

Связанная документация

Руководства по интеграции CloudPrint, подключению локального агента и надёжной работе печати.