search

Schulconnex / Schulconnex

Other
4 stars 1 forks source link

Sammlung von Auffälligkeiten (Review und Polishing) #235

Open gorkemg opened 2 weeks ago

gorkemg commented 2 weeks ago

Auffälligkeiten sammeln und zur Diskussion aufbereiten.

Dieses Issue ist Teil von #227 Review und Polishing der Spezifikation.

gorkemg commented 1 week ago

Die Kategorie "Schnittstellendefinition" klingt unpassend und könnte verwirrend sein, da der Inhalt hauptsächlich HTTP-Status-Codes beschreibt. Eine Umbenennung und Umstrukturierung wäre empfehlenswert.

Zum Beispiel: "Schnittstellendefinitionen" umbenennen in "Status-Codes". Die Unterseiten "Fehlerbehandlungen" und "Validierung" könnten in "Status-Codes" mit aufgenommen werden, so dass sie als Unterkategorien in "Status-Codes" zu finden sind.

Aufbau wäre dann: Status-Codes

gorkemg commented 1 week ago

Auch "Schnittstellen für Quellsysteme und Dienste" könnte vereinfacht werden.

Statt "Schnittstellen für Quellsysteme und Dienste" könnte man die Unterseiten aufteilen in „Autorisierung und Authentifizierung“ und "Erweitert".

Der Aufbau würde wie folgt aussehen:

bwhdien commented 3 days ago

Die Kategorie "Schnittstellendefinition" klingt unpassend und könnte verwirrend sein, da der Inhalt hauptsächlich HTTP-Status-Codes beschreibt. Eine Umbenennung und Umstrukturierung wäre empfehlenswert.

Zum Beispiel: "Schnittstellendefinitionen" umbenennen in "Status-Codes". Die Unterseiten "Fehlerbehandlungen" und "Validierung" könnten in "Status-Codes" mit aufgenommen werden, so dass sie als Unterkategorien in "Status-Codes" zu finden sind.

Aufbau wäre dann: Status-Codes

  • Allgemeine Festlegungen
  • Erfolgreiche Ausführung
  • Fehlerbehandlungen
  • Validierung

Vorschlag für den Titel "Allgemeine Festlegungen für die REST-Schnittstelle"

bwhdien commented 3 days ago

Auch "Schnittstellen für Quellsysteme und Dienste" könnte vereinfacht werden.

Statt "Schnittstellen für Quellsysteme und Dienste" könnte man die Unterseiten aufteilen in „Autorisierung und Authentifizierung“ und "Erweitert".

Der Aufbau würde wie folgt aussehen:

  • Autorisierung und Authentifizierung

    • Autorisierung Dienstanbieter
    • Autorisierung Quellsysteme

  • Erweitert

    • OIDC-Claims
    • Herstellereigene Attribute

Jede API (Dienste, QS) sollte einen Abschnitt "Authentisierung und Autorisierung" haben, die Dienste-API den Abschnitt "OIDC". "Anbietersp. Attr." geht wohl in den gemeinsamen Teil.