Callback für Subscriber um Destinations erweitern

Warum?

Vom Land Hessen wurde folgender Vorschlag / Wunsch geäußert:

In dem Callback, der vom Subscriber für eine Destination angelegt wird, soll im Payload den Callbacks eine Referenz auf die Destination, für die Submissions vorliegen, damit der Client weiß, für welche Destination der Client diese Submissions abrufen muss.

Relevante Links und Bemerkungen

Vorschlag für Payload:

Vorschlag A:

"destinations": [{ "destinationId": "xxx", "submissionIds": ["..."] }]

Vorschlag B:

"destinations": { "{destinationId}": { "submissionids": ["..."] } }

Vorschlag C (Hinweis von Alex: Hab mir mal den konkreten Payload hergenommen, um mein Vorschlag verdeutlichen. Würde auf Annahme basieren, dass pro Destination ein Callback rausgeht)

{
  "CallbackNewSubmissions": {
    "title": "Callback",
    "description": "Callback, der über abholbereite Einreichungen informiert.",
    "type": "object",
    "properties": {
      "type": {
        "title": "Art des Callbacks",
        "description": "Es liegen neue Einreichungen vor",
        "type": "string",
        "enum": [
          "https://schema.fitko.de/fit-connect/submission-api/callbacks/new-submissions"
        ]
      },
      "destinationId": {
        "title": "Destination-ID",
        "description": "Destination-ID, für die Submissions vorliegen",
        "type": "string",
      },
      "submissionIds": {
        "title": "Liste abholbereiter Einreichungen",
        "description": "Liste von `submissionId`s aller Einreichungen, die zur Abholung bereitstehen",
        "type": "array",
        "minItems": 1,
        "items": null
      }
    }
  }
}

Akzeptanzkriterien

  1. Callback Payload enthält eine Referenz auf die Destination, für die Submissions vorliegen
  2. API Änderungen ist für Clients abwärtskompatibel

Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)

Edited by Alexander Hoose