Przy jakich zmianach odpowiedzi API powinniśmy podnosić wersję, a przy jakich nie?

Wersję API należy zwiększyć przy wprowadzaniu zmian, które naruszają zgodność wsteczną (zmiany łamiące). Do takich zmian należą:

• Usunięcie lub zmiana nazwy istniejących pól w odpowiedzi.
• Zmiana typu danych pól.
• Zmiana struktury odpowiedzi, uniemożliwiająca klientom poprawne przetwarzanie danych.

Zmiany, które nie wymagają zwiększenia wersji:

• Dodanie nowych opcjonalnych pól w odpowiedzi (klienci mogą je zignorować).
• Dodanie nowych punktów końcowych.
• Naprawa błędów nie wpływających na strukturę i format odpowiedzi.

W związku z tym, jeśli zmiany mogą zepsuć istniejących klientów, konieczne jest zwiększenie wersji API.