API-Definition für Zugang anlegen ergänzt

europace / partner-api

Dokumentation für Partner API

1 stars 0 forks source link

API-Definition für Zugang anlegen ergänzt #52

Closed MikeKrueger75 closed 3 years ago

MikeKrueger75 commented 3 years ago

Zugang (Get/Post) hinzugefügt
Auth auf http/Bearer angepasst
Error-Modell hinzugefügt
Tags aufgeräumt Durch die Benutzung von Stoplight, wurden einige Daten in Hochkomma gesetzt, was wahrscheinlich konformer ist.

Ich brauche bitte auch fachliches Feedback zum Design als SubRessource. Ticket: https://europace.atlassian.net/browse/PARTNER-511

Vielen Dank fürs Review.

gruenewa commented 3 years ago

Gefällt mir soweit sehr gut. :+1: Was mir noch unklar ist:

Was genau geben wir bei der GET Operation zurück, wenn die Plakette noch keinen Zugang hat?
Beim POST würde ich auch einen 406 Fehler zurückgeben, wenn der Zugang bereits aktiviert ist, richtig?

gruenewa commented 3 years ago

Die Implementierung des Status

REGISTERED
NO_USER_CREDENTIALS
UNVERIFIED macht eventuell Zusatzaufwand. Auch ist mir die Abgrenzung der verschiedenen Zustände nicht ganz klar. Ein Nutzer ohne verifizierten Zugang ist ja eigentlich auch registriert, richtig? Und ich bin mir nicht sicher, ob ich aktuell überhaupt an den Daten erkennen kann, ob ein Nutzer ein Passwort hinterlegt hat. Mindestens für SSO Nutzer dürfte das ja schon heute der Fall sein. Muss hier erstmal im Code schauen, wie wir das heutzutage erkennen. TL;DR: eventuell kann man in einer ersten Version auf das Flag 'status' verzichten?

Aktuell haben wir auf der Plattform an einer Plakette fogende ZugangsStatus:

KEIN_ZUGANG("Kein Zugang"),
ZUGANG_UNBESTAETIGT("Zugang noch nicht bestätigt"),
ZUGANG_REGISTRIERT("Registriert"),
ZUGANG_REGISTRIERT_KEIN_ZUGANG("Kein Zugang"),
BENUTZERNAME_AENDERUNG_UNBESTAETIGT("Änderung des Benutzernamens noch nicht bestätigt");

MikeKrueger75 commented 3 years ago

Ich bräuchte noch Klärung bzgl.

Was genau geben wir bei der GET Operation zurück, wenn die Plakette noch keinen Zugang hat?

Beim POST würde ich auch einen 406 Fehler zurückgeben, wenn der Zugang bereits aktiviert ist, richtig?

Mir sind die Elemente im Status Feld unklar. Hier ist zunächst zu karen, wie der Zustand in unseren Datenbank auf diesen Enum mappt

Wenn es keinen Zugang gibt, dann wird folgendes zurückgegeben:

{
"partnerId": "SCR06",
"benutzername": "",
"status": "KEIN_ZUGANG",
"identityProviderConfigURL": "https://api.europace.de/auth/.well-known/openid-configuration"
}

Zur Fehlermeldung: ich habe den Case ergänzt, aber Fehlercode wäre 406 👍🏻
die Statuscodes habe ich auf unseren internen angepasst - diese sind sprechend und in der GUI nachvollziehbar

caspii commented 3 years ago

Ich finde es gut!

Verständnisfrage: sehe ich es richtig das mit der neuen API gar keine Plaketten bisher angelegt werden können?

Die Enums

KEIN_ZUGANG("Kein Zugang"),
ZUGANG_UNBESTAETIGT("Zugang noch nicht bestätigt"),
ZUGANG_REGISTRIERT("Registriert"),
ZUGANG_REGISTRIERT_KEIN_ZUGANG("Kein Zugang"),
BENUTZERNAME_AENDERUNG_UNBESTAETIGT("Änderung des Benutzernamens noch nicht bestätigt");

hätte ich anders benannt aber sind ja scheinbar schon festgelegt.

gruenewa commented 3 years ago

Ich habe mal alle Findings dieses PRs in https://github.com/europace/partner-api/pull/53 zum Review umgesetzt, so dass man die Changes mal sieht und vergleichen kann.