Skip to content

Add Transition-Connect-API Draft Endpoints

Konrad Mohrfeldt requested to merge wechange into release-24

Dieser Merge Request fügt Endpunkte für Events und Organisations (in unserem Kontext Groups) hinzu. Ich denke es gibt noch ein paar Baustellen, bevor wir das mergen sollten:

  1. @robert sollte noch mal auf die Serializer schauen, um zu sehen, ob die Daten auf die korrekte Art und Weise ausgeliefert werden. Ich sehe da eher die Events als die Organisations, weil erstere das wesentlich komplexere Datenmodell haben.

  2. Es gibt mehrere ToDos zu Datenfeldern, die der Transition-Connect-API Entwurf fordert, wir aber nicht liefern wollen oder können. Entweder sind wir so zufrieden und entfernen die ToDos, wir implementieren die Felder oder melden unsere probleme Upstream.

  3. Im Transition-Connect-API Entwurf ist /api fest als Basis-Endpunkt definiert. Damit gibt es zwei Probleme:

    • wir nutzen für Endpunkte mit Awendungslogik den stadt Namespace in URLs. Hier werfen wir jetzt noch zusätzlich api in den Ring.
    • würden wir /stadt/api nehmen, kollidieren wir mit unserer eigenen API. Gerade gibt es dort noch keine Konflikte, aber aus meiner sicht wäre es schlau unsere eigene und die Transition-Connect-API zu trennen.

    Eine gute Lösung wäre hier vielleicht die Definition eines meta Tags, dass den Endpunkt für Clients definiert, z.B.:

        <meta name="transition-connect-base" content="/stadt/transition-connect-api">

    Darauf könnten wir uns erstmal mit den Menschen von wechange einigen und anschließend diesen Vorschlag Upstream einreichen.

Wollen wir diese Punkte in diesem Merge Request erarbeiten oder im Rahmen eines Milestones umsetzen?

Zusätzliche Informationen:

Edited by Konrad Mohrfeldt

Merge request reports