Changelog
Jede Änderung am öffentlichen v1-Vertrag wird vor der Auslieferung anhand der Kompatibilitätsrichtlinie geprüft. Additive Änderungen - neue Endpunkte, neue optionale Request-Felder, neue Response-Felder, neue Webhook-Events - werden fortlaufend innerhalb von v1 ausgeliefert und erfordern nie eine Migration.
Was Sie erwarten können
- Neue Endpunkte und Felder können jederzeit erscheinen. Tolerieren Sie unbekannte Response-Felder, statt daran zu scheitern.
- Bestehende
v1-Operationen und dokumentierte Erfolgsstatuscodes werden nicht entfernt, und bestehende Schreiboperationen erhalten keine neuen Pflichtparameter, Pflicht-Request-Bodies oder erforderlichen JSON-Eigenschaften. - Das SDK-Operationsmapping und die kuratierten MCP-Tools werden in CI gegen den aktuellen Vertrag geprüft, sodass ihre Routen und erforderlichen Scopes nicht unbemerkt abweichen können.
Änderungen verfolgen
- Die API-Referenz spiegelt stets den aktuell ausgelieferten Vertrag wider - vergleichen Sie sie beim Upgrade mit Ihrer Integration.
- Breaking Changes unterliegen der Migrations- und Versionierungsrichtlinie, die den erforderlichen Prüf-, Ankündigungs- und Migrationsweg definiert.