Callbacks vs. Webhooks
User Story
Als Nutzer der Submission API
möchte ich eine technisch korrekte OpenAPI Spezifikation haben
damit Tools wie Linter, Codegeneratoren, etc. sauber und ohne Warnings / Errors durchlaufen.
Why
Als wir mit den APIs angefangen haben, hatte die Spec noch keine Webhooks und wir sind auf Callbacks gegangen, da sie unseren Anwendungsfall ab besten abdecken. Seit OpenAPI 3.1.0 klappt das mit den Webbhooks aber gut und wir könnten das verwenden.
Links, Notes, Remarks
- Info zu Webhooks
- Schaut man sich die Dateien an, so findet man unter
spec/callbacks/*.yaml
immer auch eine komische URL:https://example.org/callback
. Das ist für Callbacks nötig, nicht aber für Webhooks. Guut. - Löst auch das Problem mit den Warnings im Linter:
- TODO: In der API sind auch noch Felder die
callback
heissen. - TODO: Klären ob man das auch nach außen hin umbenennt (Doku) und in der API (. Stichwort v2 der API und in der Doku.
Acceptance criteria
-
Die Submission API verwendet keine Callbacks mehr.
Implementation plan (to be completed by the developer)
-
... -
... -
... -
Definition of Done was checked.