Breaking Change in /api/permissions/global

daniel-lerch

@davidschilling Gut zu hören, dass ihr standardmäßig darauf achtet und dieser konkrete Fall ein unentdeckter Fehler ist und nicht als Refactoring so geplant war.

Ich möchte den Endpunkt in Korga einbauen, um Administratoren zu warnen, falls sie dem ChurchTools Konto für diese Anwendung zu wenige Rechte eingeräumt haben.

Viele Endpunkte der API geben - zu Recht - keinen 403 Forbidden zurück, sondern eine leere Liste. Stattet man jetzt den Nutzer von Korga mit zu wenigen Rechten aus, wundert man sich, wieso manche Funktionen nicht funktionieren. Damit Administratoren dann nicht lange nach dem Fehler suchen müssen, möchte ich eine Warnung anzeigen.

daniel-lerch

Heute ist mir aufgefallen, dass das Attribut data.churchdb.'edit groups' nicht mehr existiert. Es gibt nur noch das Attribut data.churchdb.'edit group'. Ich brauche diese Attribute nicht, aber vor einiger Zeit gab es das noch und jetzt gibt es Fehler beim Mappen des JSON zu meiner Klasse.

Wie beim letzten Mal taucht das Attribut außerdem weiterhin in der OpenAPI Dokumentation auf.

daniel-lerch

@davidschilling Die OpenAPI Dokumentation zu /api/permissions/global zeigt immer noch data.churchdb.'edit groups': boolean an. Falls dieses Attribut nicht wieder hinzugefügt wird, was inhaltlich wahrscheinlich auch keinen Sinn ergäbe, wäre es super, wenn ihr die Dokumentation dahingehend aktualisieren könntet.

thommyb

@daniel-lerch Sprichst du nur den von Beispiel-Daten, die ergänzend angezeigt werden? Oder noch von etwas anderem?

daniel-lerch

@thommyb Ich meine die Beispiel-Daten. Das Schema war mir vorher noch gar nicht aufgefallen, aber im Schema sind für /api/permissions/global kaum Attribute definiert. Die meisten gibt es nur in den Beispiel-Daten. Verstehe ich die Dokumentation hier falsch und die Attribute sollen überhaupt keine sein, sondern eher eine Liste von Berechtigungen, wo jederzeit beliebige Berechtigungen entfernt und umbenannt werden können?

jziegeler

@daniel-lerch die Beispiele können unter Umständen etwas outdated sein, relevant sind eigentlich die Attribute. Sind für die nächste Version für die GlobalPermissions nachgereicht

daniel-lerch

@jziegeler Ich habe jetzt die Liste von Attributen herangezogen und bin auf folgende Probleme gestoßen:

data.churchcore.'administer custom modules' und data.churchcore.'use churchquery' werden als obligatorische Attribute aufgeführt, sind in der API Response aber nicht vorhanden
data.churchcheckin, data.churchgroup, data.churchreport und data.churchsync werden als obligatorische Attribute aufgeführt, sind in der API Response aber nicht vorhanden, falls die betreffenden Module deaktiviert sind.

jziegeler

@daniel-lerch danke für den Hinweis, habe ich für die nächste Version gefixt

daniel-lerch

@davidschilling @jziegeler Ich habe mal wieder einen Breaking Change im Endpunkt für Berechtigungen gefunden:

data.churchreport.'edit masterdata' ist laut OpenAPI Spezifikation ein obligatorisches Feld, fehlt allerdings inzwischen bei Aufrufen. Bemerkt habe ich das Problem am 3. September, kann allerdings nicht ausschließen, dass es schon länger besteht.

davidschilling

@daniel-lerch Danke für die Meldung. Ich schau mir das an. Da es im Report Modul keine Stammdaten mehr gibt wurde das Recht entfernt. Ich werde es jetzt auch aus der Api-Doku entfernen.