From 27140cd5d61f52727043d26e7bea1213b955ba9e Mon Sep 17 00:00:00 2001 From: Florian Kaufmann <florian.kaufmann@codecentric.de> Date: Thu, 11 Nov 2021 15:28:38 +0100 Subject: [PATCH] Fix von weiteren kaputten submission-api schema links --- docs/getting-started/event-log.mdx | 18 +++++++++--------- .../receiving/process-and-acknowledge.mdx | 10 +++++----- docs/getting-started/sending/query-status.mdx | 2 +- docs/status-and-error-codes.md | 2 +- .../src/main/java/GenerateSignedToken.java | 2 +- .../getting-started/event-log.mdx | 18 +++++++++--------- .../receiving/process-and-acknowledge.mdx | 10 +++++----- .../getting-started/sending/query-status.mdx | 2 +- .../status-and-error-codes.md | 2 +- 9 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/getting-started/event-log.mdx b/docs/getting-started/event-log.mdx index 82fda3491..5359c936f 100644 --- a/docs/getting-started/event-log.mdx +++ b/docs/getting-started/event-log.mdx @@ -42,13 +42,13 @@ In der folgenden Tabelle sind die möglichen Ereignisse, ihre Beschreibungen und | Event | Autor | Bedeutung | |-----------------------------------------------------------------|---------------------|-------------------------------| -| `https://schema.fitko.de/fit-connect/events/create-submission` | Zustelldienst | Die Einreichung wurde durch den Sender angelegt. | -| `https://schema.fitko.de/fit-connect/events/submit-submission` | Zustelldienst | Die Einreichung wurde durch den Sender abgesendet. | -| `https://schema.fitko.de/fit-connect/events/notify-submission` | Zustelldienst | Der Empfänger wurde per Webhook über die Einreichung informiert. | -| `https://schema.fitko.de/fit-connect/events/forward-submission` | Empfangendes System | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. | -| `https://schema.fitko.de/fit-connect/events/reject-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger zurückgewiesen. | -| `https://schema.fitko.de/fit-connect/events/accept-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. | -| `https://schema.fitko.de/fit-connect/events/delete-submission` | Zustelldienst | Die Einreichung wurde durch den Zustelldienst gelöscht. | +| `https://schema.fitko.de/fit-connect/submission-api/events/create-submission` | Zustelldienst | Die Einreichung wurde durch den Sender angelegt. | +| `https://schema.fitko.de/fit-connect/submission-api/events/submit-submission` | Zustelldienst | Die Einreichung wurde durch den Sender abgesendet. | +| `https://schema.fitko.de/fit-connect/submission-api/events/notify-submission` | Zustelldienst | Der Empfänger wurde per Webhook über die Einreichung informiert. | +| `https://schema.fitko.de/fit-connect/submission-api/events/forward-submission` | Empfangendes System | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. | +| `https://schema.fitko.de/fit-connect/submission-api/events/reject-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger zurückgewiesen. | +| `https://schema.fitko.de/fit-connect/submission-api/events/accept-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. | +| `https://schema.fitko.de/fit-connect/submission-api/events/delete-submission` | Zustelldienst | Die Einreichung wurde durch den Zustelldienst gelöscht. | ## Prüfung eines Security-Event-Token (SET) {#set-validation} @@ -94,7 +94,7 @@ In der Payload des signierten SET MÜSSEN die folgenden [standardisierten Felder "jti": "0BF6DBF6-CE7E-44A3-889F-82FE74C3E715", "sub": "submission:F65FEAB2-4883-4DFF-85FB-169448545D9F", "events": { - "https://schema.fitko.de/fit-connect/events/accept-submission": {} + "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission": {} }, "txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90" } @@ -240,7 +240,7 @@ Konkret sind das hier: "jti": "0BF6DBF6-CE7E-44A3-889F-82FE74C3E715", "sub": "submission:F65FEAB2-4883-4DFF-85FB-169448545D9F", "events": { - "https://schema.fitko.de/fit-connect/events/accept-submission": {} + "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission": {} }, "txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90" } diff --git a/docs/getting-started/receiving/process-and-acknowledge.mdx b/docs/getting-started/receiving/process-and-acknowledge.mdx index 6ee001696..40f3fa7fb 100644 --- a/docs/getting-started/receiving/process-and-acknowledge.mdx +++ b/docs/getting-started/receiving/process-and-acknowledge.mdx @@ -14,9 +14,9 @@ Wie auf der [Event Log Übersichtsseite](../event-log.mdx#events) zu sehen, gibt | Event | Autor | Bedeutung | |-----------------------------------------------------------------|---------------------|-------------------------------| -| `https://schema.fitko.de/fit-connect/events/forward-submission` | | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. | -| `https://schema.fitko.de/fit-connect/events/reject-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger zurückgewiesen. | -| `https://schema.fitko.de/fit-connect/events/accept-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. | +| `https://schema.fitko.de/fit-connect/submission-api/events/forward-submission` | | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. | +| `https://schema.fitko.de/fit-connect/submission-api/events/reject-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger zurückgewiesen. | +| `https://schema.fitko.de/fit-connect/submission-api/events/accept-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. | Um diese Events bzw. ein entsprechendes Event korrekt an den Zustelldienst zu versenden, muss es in Form eines SETs an diesen gesendet werden. @@ -37,7 +37,7 @@ Weiterhin ist es notwendig, dass die Id der Einreichung und des zugehörigen Vor ```java title=Annahmen JWK key; String subject = "submission:f65feab2-4883-4dff-85fb-169448545d9f"; - String event ="https://schema.fitko.de/fit-connect/events/accept-submission"; + String event ="https://schema.fitko.de/fit-connect/submission-api/events/accept-submission"; String transactionId = "case:f73d30c6-8894-4444-8687-00ae756fea90"; ``` @@ -111,7 +111,7 @@ Das letzte SET aus obigem Beispiel hat folgenden Payload. "jti": "0BF6DBF6-CE7E-44A3-889F-82FE74C3E715", "sub": "submission:F65FEAB2-4883-4DFF-85FB-169448545D9F", "events": { - "https://schema.fitko.de/fit-connect/events/accept-submission": {} + "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission": {} }, "txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90" } diff --git a/docs/getting-started/sending/query-status.mdx b/docs/getting-started/sending/query-status.mdx index 33b7e78db..e88a7ba50 100644 --- a/docs/getting-started/sending/query-status.mdx +++ b/docs/getting-started/sending/query-status.mdx @@ -55,7 +55,7 @@ Das letzte, aktuellste Security-Event-Token hat folgenden Payload. "jti": "0BF6DBF6-CE7E-44A3-889F-82FE74C3E715", "sub": "submission:F65FEAB2-4883-4DFF-85FB-169448545D9F", "events": { - "https://schema.fitko.de/fit-connect/events/accept-submission": {} + "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission": {} }, "txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90" } diff --git a/docs/status-and-error-codes.md b/docs/status-and-error-codes.md index c603479f8..7df2a2034 100644 --- a/docs/status-and-error-codes.md +++ b/docs/status-and-error-codes.md @@ -17,7 +17,7 @@ Diese Seite gibt einen Überblick über Fehlerhandling in der FIT-Connect Submis nach [RFC 7807 (Problem Details for HTTP APIs)](https://datatracker.ietf.org/doc/html/rfc7807) aus. * Fehler besitzen **immer** folgende Felder: * `type`: Eine URI (möglicherweise als Website aufrufbar) die den Typ des Fehlers eindeutig klassifiziert. - Beispiel: `https://schema.fitko.de/fit-connect/problems/submission-not-found` + Beispiel: `https://schema.fitko.de/fit-connect/submission-api/problems/submission-not-found` * `title`: Ein kurzer und menschenlesbarer Titel des Fehlers. Beispiel: `Application not found` * `status`: Eine Kopie des HTTP Statuscodes * Fehler können **optional** weitere Felder beinhalten. API Clients **müssen** hiermit umgehen können. diff --git a/examples/java/encryption/src/main/java/GenerateSignedToken.java b/examples/java/encryption/src/main/java/GenerateSignedToken.java index 7190812e5..b2b9bde21 100644 --- a/examples/java/encryption/src/main/java/GenerateSignedToken.java +++ b/examples/java/encryption/src/main/java/GenerateSignedToken.java @@ -20,7 +20,7 @@ public class GenerateSignedToken { private static final UUID signatureKeyId = UUID.fromString("6508dbcd-ab3b-4edb-a42b-37bc69f38fed"); private static final String subject = "submission:f65feab2-4883-4dff-85fb-169448545d9f"; - private static final String event = "https://schema.fitko.de/fit-connect/events/accept-submission"; + private static final String event = "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission"; private static final String transactionId = "case:f73d30c6-8894-4444-8687-00ae756fea90"; diff --git a/versioned_docs/version-FIT-Connect_v1/getting-started/event-log.mdx b/versioned_docs/version-FIT-Connect_v1/getting-started/event-log.mdx index 82fda3491..5359c936f 100644 --- a/versioned_docs/version-FIT-Connect_v1/getting-started/event-log.mdx +++ b/versioned_docs/version-FIT-Connect_v1/getting-started/event-log.mdx @@ -42,13 +42,13 @@ In der folgenden Tabelle sind die möglichen Ereignisse, ihre Beschreibungen und | Event | Autor | Bedeutung | |-----------------------------------------------------------------|---------------------|-------------------------------| -| `https://schema.fitko.de/fit-connect/events/create-submission` | Zustelldienst | Die Einreichung wurde durch den Sender angelegt. | -| `https://schema.fitko.de/fit-connect/events/submit-submission` | Zustelldienst | Die Einreichung wurde durch den Sender abgesendet. | -| `https://schema.fitko.de/fit-connect/events/notify-submission` | Zustelldienst | Der Empfänger wurde per Webhook über die Einreichung informiert. | -| `https://schema.fitko.de/fit-connect/events/forward-submission` | Empfangendes System | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. | -| `https://schema.fitko.de/fit-connect/events/reject-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger zurückgewiesen. | -| `https://schema.fitko.de/fit-connect/events/accept-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. | -| `https://schema.fitko.de/fit-connect/events/delete-submission` | Zustelldienst | Die Einreichung wurde durch den Zustelldienst gelöscht. | +| `https://schema.fitko.de/fit-connect/submission-api/events/create-submission` | Zustelldienst | Die Einreichung wurde durch den Sender angelegt. | +| `https://schema.fitko.de/fit-connect/submission-api/events/submit-submission` | Zustelldienst | Die Einreichung wurde durch den Sender abgesendet. | +| `https://schema.fitko.de/fit-connect/submission-api/events/notify-submission` | Zustelldienst | Der Empfänger wurde per Webhook über die Einreichung informiert. | +| `https://schema.fitko.de/fit-connect/submission-api/events/forward-submission` | Empfangendes System | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. | +| `https://schema.fitko.de/fit-connect/submission-api/events/reject-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger zurückgewiesen. | +| `https://schema.fitko.de/fit-connect/submission-api/events/accept-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. | +| `https://schema.fitko.de/fit-connect/submission-api/events/delete-submission` | Zustelldienst | Die Einreichung wurde durch den Zustelldienst gelöscht. | ## Prüfung eines Security-Event-Token (SET) {#set-validation} @@ -94,7 +94,7 @@ In der Payload des signierten SET MÜSSEN die folgenden [standardisierten Felder "jti": "0BF6DBF6-CE7E-44A3-889F-82FE74C3E715", "sub": "submission:F65FEAB2-4883-4DFF-85FB-169448545D9F", "events": { - "https://schema.fitko.de/fit-connect/events/accept-submission": {} + "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission": {} }, "txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90" } @@ -240,7 +240,7 @@ Konkret sind das hier: "jti": "0BF6DBF6-CE7E-44A3-889F-82FE74C3E715", "sub": "submission:F65FEAB2-4883-4DFF-85FB-169448545D9F", "events": { - "https://schema.fitko.de/fit-connect/events/accept-submission": {} + "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission": {} }, "txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90" } diff --git a/versioned_docs/version-FIT-Connect_v1/getting-started/receiving/process-and-acknowledge.mdx b/versioned_docs/version-FIT-Connect_v1/getting-started/receiving/process-and-acknowledge.mdx index 6ee001696..40f3fa7fb 100644 --- a/versioned_docs/version-FIT-Connect_v1/getting-started/receiving/process-and-acknowledge.mdx +++ b/versioned_docs/version-FIT-Connect_v1/getting-started/receiving/process-and-acknowledge.mdx @@ -14,9 +14,9 @@ Wie auf der [Event Log Übersichtsseite](../event-log.mdx#events) zu sehen, gibt | Event | Autor | Bedeutung | |-----------------------------------------------------------------|---------------------|-------------------------------| -| `https://schema.fitko.de/fit-connect/events/forward-submission` | | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. | -| `https://schema.fitko.de/fit-connect/events/reject-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger zurückgewiesen. | -| `https://schema.fitko.de/fit-connect/events/accept-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. | +| `https://schema.fitko.de/fit-connect/submission-api/events/forward-submission` | | Ein nachgelagertes System hat die Einreichung zur Weiterleitung übernommen. | +| `https://schema.fitko.de/fit-connect/submission-api/events/reject-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger zurückgewiesen. | +| `https://schema.fitko.de/fit-connect/submission-api/events/accept-submission` | Empfangendes System | Die Einreichung wurde durch den Empfänger akzeptiert. | Um diese Events bzw. ein entsprechendes Event korrekt an den Zustelldienst zu versenden, muss es in Form eines SETs an diesen gesendet werden. @@ -37,7 +37,7 @@ Weiterhin ist es notwendig, dass die Id der Einreichung und des zugehörigen Vor ```java title=Annahmen JWK key; String subject = "submission:f65feab2-4883-4dff-85fb-169448545d9f"; - String event ="https://schema.fitko.de/fit-connect/events/accept-submission"; + String event ="https://schema.fitko.de/fit-connect/submission-api/events/accept-submission"; String transactionId = "case:f73d30c6-8894-4444-8687-00ae756fea90"; ``` @@ -111,7 +111,7 @@ Das letzte SET aus obigem Beispiel hat folgenden Payload. "jti": "0BF6DBF6-CE7E-44A3-889F-82FE74C3E715", "sub": "submission:F65FEAB2-4883-4DFF-85FB-169448545D9F", "events": { - "https://schema.fitko.de/fit-connect/events/accept-submission": {} + "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission": {} }, "txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90" } diff --git a/versioned_docs/version-FIT-Connect_v1/getting-started/sending/query-status.mdx b/versioned_docs/version-FIT-Connect_v1/getting-started/sending/query-status.mdx index 33b7e78db..e88a7ba50 100644 --- a/versioned_docs/version-FIT-Connect_v1/getting-started/sending/query-status.mdx +++ b/versioned_docs/version-FIT-Connect_v1/getting-started/sending/query-status.mdx @@ -55,7 +55,7 @@ Das letzte, aktuellste Security-Event-Token hat folgenden Payload. "jti": "0BF6DBF6-CE7E-44A3-889F-82FE74C3E715", "sub": "submission:F65FEAB2-4883-4DFF-85FB-169448545D9F", "events": { - "https://schema.fitko.de/fit-connect/events/accept-submission": {} + "https://schema.fitko.de/fit-connect/submission-api/events/accept-submission": {} }, "txn": "case:F73D30C6-8894-4444-8687-00AE756FEA90" } diff --git a/versioned_docs/version-FIT-Connect_v1/status-and-error-codes.md b/versioned_docs/version-FIT-Connect_v1/status-and-error-codes.md index c603479f8..7df2a2034 100644 --- a/versioned_docs/version-FIT-Connect_v1/status-and-error-codes.md +++ b/versioned_docs/version-FIT-Connect_v1/status-and-error-codes.md @@ -17,7 +17,7 @@ Diese Seite gibt einen Überblick über Fehlerhandling in der FIT-Connect Submis nach [RFC 7807 (Problem Details for HTTP APIs)](https://datatracker.ietf.org/doc/html/rfc7807) aus. * Fehler besitzen **immer** folgende Felder: * `type`: Eine URI (möglicherweise als Website aufrufbar) die den Typ des Fehlers eindeutig klassifiziert. - Beispiel: `https://schema.fitko.de/fit-connect/problems/submission-not-found` + Beispiel: `https://schema.fitko.de/fit-connect/submission-api/problems/submission-not-found` * `title`: Ein kurzer und menschenlesbarer Titel des Fehlers. Beispiel: `Application not found` * `status`: Eine Kopie des HTTP Statuscodes * Fehler können **optional** weitere Felder beinhalten. API Clients **müssen** hiermit umgehen können. -- GitLab