Milyen API-válasz változtatásoknál kell növelni a verziót, és melyiknél nem?

Az API verzióját növelni kell, amikor olyan változtatásokat hajtanak végre, amelyek megsértik a visszafelé kompatibilitást (breaking changes). Ezek a változtatások a következők:

• A meglévő mezők törlése vagy átnevezése a válaszban.
• A mezők adattípusának módosítása.
• A válasz szerkezetének módosítása, ami megakadályozza, hogy az ügyfelek helyesen dolgozzák fel az adatokat.

Az olyan változtatások, amelyek nem igényelnek verziószám növelést:

• Új, opcionális mezők hozzáadása a válaszhoz (az ügyfelek figyelmen kívül hagyhatják őket).
• Új végpontok hozzáadása.
• Hibák javítása, amelyek nem befolyásolják a válasz szerkezetét és formátumát.

Ezért, ha a változtatások megszakíthatják a meglévő ügyfeleket, növelni kell az API verzióját.