Dokumentation der third party api auf "Datenbündel" anpassen

In einem der letzten Sprint session wurde erwähnt, dass die Third-Party-Api breaking changes hat - bitte dokumentieren/doku anpassen.

changed milestone to %Release 1.0.1

added Dokumentation label

assigned to @benjaminLedel

assigned to @LenDigLearn and unassigned @benjaminLedel

mentioned in commit 53ef3e7f

Ist angepasst

closed

@LenDigLearn Könntest du vielleicht kurz zusammenfassen, was die breaking-Changes sind? (Würde mir sehr viel Arbeit sparen)

reopened

Bevor wir die Consents hinsichtlich Datenbündel umgebaut haben, hat man über POST consents/user/save/third-party eine Struktur geschickt, die in etwa wie folgt aufgebaut war:

{
    "user_id": EMAIL_DES_USERS,
    "provider_schema_id": PRIMARY_KEY_DES_PROVIDER_SCHEMAS,
    "verbs":
    [
        {"provider": PRIMARY_KEY_DES_PROVIDERS, "id": "...", "consented": true, "objects": ["...", "..."]}
    ]
}

wobei die ... jeweils Verb- und Objekt-IDs (URLs) sind.

Nach der Änderung muss folgende Struktur vorliegen:

{
    "user_id": EMAIL_DES_USERS,
    "groups": [PRIMARY_KEY_GRUPPE_1, ...]
}

Die Gruppen-IDs lassen sich mit dem Endpoint consents/provider-status/third-party abrufen - hier werden alle dem Provider zugeordneten Datenbündel im zurückgegebenen Attribut "groups" als Objekte übergeben, die u.A. den Key id enthalten.

Falls erwünscht ist, dass für die Übergabe anstatt der Primary keys die automatisch erzeugten textuellen Identifier verwendet werden, ließe sich das auch unkompliziert umsetzen.

mentioned in issue #168

Die Änderungen sind für mich jetzt nachvollziehbar und ein zustimmen hat auch funktioniert. Nur beim abrufen erhalte ich noch nicht alle zugestimmten gruppen - das ist aber kein Dokumentationsproblem (glaube ich). Siehe #171

closed