1. Geschiedenis
Nog geen brekende wijzigingen. Het openbare deel van de Audact-API is nog niet stabiel verklaard. Zodra het eerste openbaar stabiele endpoint uitkomt, wordt elke brekende wijziging daarin hier vastgelegd, onder het afschrijvingsbeleid van twaalf maanden.
2. Wat telt als een breaking change
- Het verwijderen of hernoemen van een openbaar endpoint, een padparameter of een queryparameter
- Het verwijderen van een veld uit het antwoord, of een wijziging van het type daarvan
- Een wijziging in de authenticatie, de rate-limiet of de betekenis van foutcodes
- Wijzigingen in het schema van een webhook-payload, anders dan het toevoegen van velden
Toevoegingen die achterwaarts compatibel zijn – nieuwe optionele velden, nieuwe endpoints, nieuwe enum-waarden waar afnemers onbekende waarden verdragen – zijn geen brekende wijziging en staan in de gewone changelog.
Verwante documenten