API-Dokumentation passt nicht zu API-Ergebnissen

[volkerwiegand]

Hallo,

ich plane die Buchhaltung nur über das API zu verwenden, allerdings ist die Dokumentation, die ich per https://meine-gemeinde.church.tools/system/runtime/swagger/openapi.json aufrufen kann, nicht konsistent.

Z.B. sollen die Meta-Daten eine createdPersonId enthalten, es ist aber ein Object createdPerson mit einem Feld Id. Kleine Unstimmigkeiten ziehen sich praktisch durch das gesamte Swagger-Dokument. Ich muss also jeden Endpoint einmal aufrufen und die übertragenen Daten anschauen. (Ich fühle mich im Moment wie Andrew Tridgell, als er Samba entwickelt hat, wer sich noch daran erinnern kann )

Meine Frage: Können wir die Dokumentation selbst an die aktuelle Implementierung anpassen? Oder wird sie bei Updates mitgeführt und ich habe eine falsche URL? Unser Hosting ist bei ChurchTools.

Lernfrage: Wie funktioniert und was kosten Self-Hosting? Was bekommt man in die Hand?

[davidschilling]

Wenn es konkrete Fehler in der Api-Dokumentation gibt beheben wir die gerne.

Die Dokumentation wird mit der ChurchTools Version ausgeliefert und kann nicht selbst angepasst werden. Du findest sie unter deiner ChurchTools Installation unter /api

Self-Hosting kostet gleich viel wie Hosting.
Da kannst du prinzipiell alles anpassen, musst du dann aber auch bei jedem Update machen.