Skip to content

Breaking change

A change that prevents previously supported consumers or uses from working as agreed.

Software architecture

An existing promise changes incompatibly

A breaking change alters a supported contract so that existing consumers must adapt or lose agreed behaviour. It can affect data format, required inputs or the meaning of a result.

In a fictional example, a job API removes the previously promised orderId field. A report relying on it can no longer identify the job. An internal rename without effects on the public contract would not be such a break. Check affected consumers, the transition path and communication before release. A new version number alone does not adapt a consumer. Even an unchanged response format can contain an incompatible change in business behaviour.

Sources