From 5ebcbb259bf59d3232fc29a053c0b0b4b9ad3d11 Mon Sep 17 00:00:00 2001 From: Marco Holz <marco.holz@fitko.de> Date: Mon, 23 Aug 2021 06:47:35 +0000 Subject: [PATCH] Add note for pending API changes --- docs/getting-started/event-log.mdx | 4 ++++ docs/getting-started/receiving/query.mdx | 2 +- docs/getting-started/sending/query-status.mdx | 4 ++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/event-log.mdx b/docs/getting-started/event-log.mdx index e433cc5e4..b57bb94cf 100644 --- a/docs/getting-started/event-log.mdx +++ b/docs/getting-started/event-log.mdx @@ -217,6 +217,10 @@ Um die Signatur eines SET zu überprüfen, welches von einem empfangenden System Die Schlüssel eines empfangenden Systems sind über die Destination in Form eines JSON Web Key (JWK) Sets öffentlich verfügbar. Welche Schritte notwendig sind und wie die Prüfung letztendlich durchgeführt wird, wird im Folgenden anhand eines Beispiels beschrieben. +:::caution Hinweis +Der Mechanismus zum Abrufen von kryptografischen Schlüsseln des empfangenden Systems wird sich bis zur Veröffentlichung der finalen API-Spezifikation noch einmal ändern. +::: + Als Ausgangslage dient das Token mit dem folgenden Header und der entsprechenden Payload. Aus dem Header wird die `kid` benötigt, sowie die `submissionId` aus dem Payload. Konkret sind das hier diff --git a/docs/getting-started/receiving/query.mdx b/docs/getting-started/receiving/query.mdx index ecdbdadb5..0ad761d47 100644 --- a/docs/getting-started/receiving/query.mdx +++ b/docs/getting-started/receiving/query.mdx @@ -21,7 +21,7 @@ Im Endeffekt, ist es jedoch ein Array mit UUIDs für jede bereitstehende Einreic ``` :::caution Hinweis -Der Mechanismus zum Konfigurieren und Entgegennehmen von Callbacks wird sich bis zur Verföffentlichung der finalen API-Spezifikation noch einmal ändern. +Der Mechanismus zum Konfigurieren und Entgegennehmen von Callbacks wird sich bis zur Veröffentlichung der finalen API-Spezifikation noch einmal ändern. ::: diff --git a/docs/getting-started/sending/query-status.mdx b/docs/getting-started/sending/query-status.mdx index a11f33807..a4fc50e72 100644 --- a/docs/getting-started/sending/query-status.mdx +++ b/docs/getting-started/sending/query-status.mdx @@ -65,3 +65,7 @@ In dem SET ist folgende Information abgelegt: Aus dem Event des SET lässt sich ableiten, dass der aktuelle Status der Einreichung `accepted` ist und der Zeitpunkt des Übergangs der 04.06.2021 um 08:48:52 GMT+0 war. Da alle SETs im Event Log signiert sind, kann diese Signatur auch noch überprüft werden. Die Überprüfung ist im Artikel zum [Event Log](../event-log.mdx#set-validation) beschrieben. + +:::caution Hinweis +Der Mechanismus zum Abrufen von kryptografischen Schlüsseln des empfangenden Systems zur Signaturprüfung wird sich bis zur Veröffentlichung der finalen API-Spezifikation noch einmal ändern. +::: \ No newline at end of file -- GitLab