Doku: Technische Dokumentation der Callbacks für Zustelldienst
User Story
Als Entwickler
brauche ich eine umfassende Dokumentation der Callback-Funktionalität im Zustelldienst,
um die Implementierung einfach nachvollziehen und Anpassungen zügig durchführen zu können.
Why
- Callback-Funktionalität arbeitet viel mit Nebenläufigkeit über den JobRunr
- Es gibt z.T. zyklische Aufrufe im Code abhängig des Verhaltens des adressierten Endpunkts
- Das Verhalten für Reply, Submission und New Event ist nicht vollständig spezifiziert
Links, Notes, Remarks
Neue Doku:
- RUNTIME: https://git.fitko.de/fit-connect/zustelldienst/-/blob/main/docs/arc42/src/06_runtime_view/06_01_callback_runtime_view.adoc?ref_type=heads
- https://git.fitko.de/fit-connect/zustelldienst/-/blob/main/docs/arc42/src/05_building_block_view/05_01_callback_building_block_view.adoc?ref_type=heads
Acceptance criteria
-
Bestehende Implementierung ist vollständig erfasst -
Wenn nötig wurden UMLs erstellt, um die Funktionalität abzubilden -
alles wurde korrekt im Sinne des arc42 Templates abgespeichert -
Sinnvolle Vereinheitlichungen und Vereinfachungen wurden identifiziert, die in #1680 (closed) und/oder #1766 (closed) überführt worden sind (#121 (closed) schließen)
Implementation plan (to be completed by the developer)
-
... -
... -
... -
Definition of Done was checked.
Follow-Up
- Info an #1766 (closed), dass die externe Doku angepasst werden kann.
Edited by Wojciech Gdaniec