Breaking Changes

Если в ручке происходят breaking changes, то необходимо поднимать её версию

Изменения

удаление всей ручки

удаление или переименование параметра

удаление или переименование поля ответа

добавление нового обязательного параметра

превращение ранее необязательного параметра в обязательный

изменение типа параметра или поля ответа

удаление значений enum

добавление нового правила проверки к существующему параметру

изменение требований к аутентификации или авторизации.

добавление ручки

добавление необязательного параметра

добавление необязательного заголовка запроса

добавление поля ответа

добавление заголовка ответа

добавление значений enum

Есть ручка GET /api/v3/quizzes/:id

Необходимо убрать поле meta - это подпадает под ломающее изменение - "удаление или переименование поля ответа"

Поэтому необходимо поднять версию

Должно стать GET /api/v4/quizzes/:id

Есть ручка GET /api/v3/quizzes/:id

Нужно добавить поле с наградами - benefits

Это неломающее изменение - "добавление поля ответа"

Поэтому версия остается прежней