Millistel API vastuse muudatustel peaksime versiooni tõstma ja millistel mitte?

API versiooni tuleks suurendada, kui tehakse muudatusi, mis rikuvad tagurpidi ühilduvust (breaking changes). Sellised muudatused hõlmavad:

• Olemasolevate väljade kustutamist või ümbernimetamist vastuses.
• Väljade andmetüübi muutmist.
• Vastuse struktuuri muutmist, mis takistab klientidel andmeid õigesti töödelda.

Muudatused, mis ei nõua versiooni suurendamist:

• Uute valikuliste väljade lisamist vastuses (kliendid võivad neid ignoreerida).
• Uute lõpp-punktide lisamist.
• Viga parandamist, mis ei mõjuta vastuse struktuuri ja formaati.

Seega, kui muudatused võivad olemasolevaid kliente rikkuda, tuleb API versiooni suurendada.