Mehr Klarheit für eure Integrationen: API-Dokumentation überarbeitet
-
Ein kleiner Heads-Up: Mit ChurchTools 3.138 (vermutlich live ab 27.10.) haben wir unsere API-Dokumentation umfassend mit KI-Unterstützung überarbeitet und mit der Implementierung abgeglichen. Viele Beschreibungen sind jetzt ausführlicher und präziser: Welche Parameter sind möglich? Welche Berechtigungen werden benötigt? Welche Daten und Fehler können zurückkommen? Auch bisher nicht dokumentierte Endpunkte und Datenfelder wurden ergänzt.
Das erleichtert euch die Entwicklung eigener Integrationen – und verbessert die Grundlage für automatisch generierte API-Clients und Typen.
Wenn ihr eigene Skripte oder Anwendungen angebunden habt: Prüft beim Update insbesondere, ob ihr eure Clients aus der OpenAPI-Spezifikation generiert. Durch korrigierte Datentypen, Pflichtfelder oder Antwortbeschreibungen können sich die generierten Typen und Methoden ändern und Anpassungen in eurem Code nötig werden. Eine Änderung in der Dokumentation bedeutet dabei nicht automatisch, dass sich auch das Verhalten des Endpunkts geändert hat.
