From 4fd852b04fb4e1ee0404c0e20face2b838c841fe Mon Sep 17 00:00:00 2001
From: Marco Holz <marco.holz@fitko.de>
Date: Wed, 20 Oct 2021 13:37:11 +0000
Subject: [PATCH] Remove manual links to API in favor of APILink component, fix
announcedContentStructure -> announcedAttachments
---
.../receiving/process-and-acknowledge.mdx | 6 ++----
docs/getting-started/sending/start-submission.mdx | 8 +++++---
docs/getting-started/sending/submit.mdx | 9 +++++----
3 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/docs/getting-started/receiving/process-and-acknowledge.mdx b/docs/getting-started/receiving/process-and-acknowledge.mdx
index 13737db84..caf5944bc 100644
--- a/docs/getting-started/receiving/process-and-acknowledge.mdx
+++ b/docs/getting-started/receiving/process-and-acknowledge.mdx
@@ -3,12 +3,10 @@ sidebar_position: 8
title: Empfangsbestätigung
---
+import ApiLink from '@site/src/components/ApiLink'
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-import ApiLink from '@site/src/components/ApiLink'
-
-
Der letzte Schritt zum Empfang einer Einreichung ist die Bestätigung des Empfangs und damit auch der Gültigkeit der Einreichung.
Mit Gültigkeit ist hier gemeint, dass alle Informationen erfolgreich heruntergeladen, entschlüsselt und im Falle der Metadaten validiert werden konnten.
@@ -44,7 +42,7 @@ Weiterhin ist es notwendig, dass die Id der Einreichung und des zugehörigen Vor
```
Die Payload- und Header-Attribute des SET müssen wie oben beschrieben definiert werden (siehe markierte Zeilen).
- Im dritten markierten Block wird das SET mit dem Schlüssel signiert und danach kann der serialisierte Wert an den [Zustelldienst](../../apis/submission-api.mdx#post-/submissions/-submissionId-/events) gesendet werden.
+ Im dritten markierten Block wird das SET mit dem Schlüssel signiert. Anschließend kann der serialisierte Wert an den Endpunkt <ApiLink to="/v1/submissions/{submissionId}/events" withMethod="post" /> gesendet werden.
```java {3-10,12-16,22-24}
try {
diff --git a/docs/getting-started/sending/start-submission.mdx b/docs/getting-started/sending/start-submission.mdx
index 1ea1ae4e2..a93bd1075 100644
--- a/docs/getting-started/sending/start-submission.mdx
+++ b/docs/getting-started/sending/start-submission.mdx
@@ -3,12 +3,14 @@ sidebar_position: 3
title: Einreichung anlegen
---
+import ApiLink from '@site/src/components/ApiLink'
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
## Eine neue Einreichung anlegen
-Das Anlegen einer neuen Einreichung über die API erfordert den Versand einer [HTTP-POST-Nachricht](../../apis/submission-api.mdx#post-/submissions), die definiert, an welchen Zustellpunkt der Einreichung versendet werden soll und welche Inhalte übermittelt werden sollen.
-Die Inhalte umfassen hierbei die Identifikatoren der Anlagen als UUIDs und die Information, ob Fachdaten mit versendet werden oder nicht.
+Das Anlegen einer neuen Einreichung erfolgt über den Endpunkt <ApiLink to="/v1/submissions" withMethod="post" /> der Submission API.
+Hierbei legt das sendende System fest, an welchen Zustellpunkt der Einreichung versendet werden soll und welche Anlagen übermittelt werden sollen.
+Anlagen werden dabei über UUIDs eindeutig identifiziert.
Die UUIDs der Anlagen müssen eindeutig sein und werden vom sendenden System festgelegt.
:::note Hinweis
@@ -33,7 +35,7 @@ $ export DESTINATION_ID=7a2668ad-3081-407c-9358-7ce4b6144b02
$ curl \
-H "Authorization: Bearer $JWT_TOKEN" \
-H "Content-Type: application/json" \
- --data "{ \"destinationId\": \"$DESTINATION_ID\", \"announcedContentStructure\": { \"data\": true, \"attachments\": [\"1da99641-2067-4e8b-b049-91b2a6c90544\", \"538a1365-092e-4d80-93b9-90eb8c1f5982\"] }, \"serviceType\": { \"name\": \"Bauantrag\", \"identifier\": \"urn:de:fim:leika:leistung:99010003001006\" } }" \
+ --data "{ \"destinationId\": \"$DESTINATION_ID\", \"announcedAttachments\": [\"1da99641-2067-4e8b-b049-91b2a6c90544\", \"538a1365-092e-4d80-93b9-90eb8c1f5982\"], \"serviceType\": { \"name\": \"Bauantrag\", \"identifier\": \"urn:de:fim:leika:leistung:99010003001006\" } }" \
-X POST $SERVICE_URL/submissions
> {
diff --git a/docs/getting-started/sending/submit.mdx b/docs/getting-started/sending/submit.mdx
index 23938c446..3034acdc3 100644
--- a/docs/getting-started/sending/submit.mdx
+++ b/docs/getting-started/sending/submit.mdx
@@ -3,15 +3,16 @@ title: Einreichung versenden
sidebar_position: 8
---
+import ApiLink from '@site/src/components/ApiLink'
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
-Die Einreichung kann abgeschlossen werden, indem mit einem PUT auf den Endpunkt [/submissions/{submissionId}](../../apis/submission-api.mdx#put-/submissions/-submissionId-) der Metadatensatz und der Fachdatensatz hochgeladen wird.
+Die Einreichung kann abgeschlossen werden, indem der Metadatensatz und der Fachdatensatz über den Endpunkt <ApiLink to="/v1/submissions/{submissionId}" withMethod="put" /> hochgeladen werden.
Diese PUT Methode kann nur folgreich durchgeführt werden, wenn folgende Bedingungen vorliegen:
-- Es muss immer ein Metadatensatz hochgeladen werden
-- Wenn über den initialen POST in der `announcedContentStructure` ein Fachdatensatz angekündigt wurde, muss dieser ebenfalls hochgeladen werden
-- Sowohl der Metadatensatz als auch der Fachdatensatz müssen verschlüsselt im JWE Format vorliegen
+- Es muss immer ein Metadatensatz hochgeladen werden.
+- Alle angekündigten Anlagen (`announcedAttachments` im Endpunkt <ApiLink to="/v1/submissions" withMethod="post" />) wurden hochgeladen.
+- Sowohl der Metadatensatz als auch der Fachdatensatz müssen verschlüsselt im JWE-Format vorliegen.
Wenn die Nutzung dieses Endpunkts erfolgreich war, wechselt die Einreichung in den Status `submitted` und die vollständige Einreichung (Anlagen, Metadatensatz und Fachdatz) liegt nun für das empfangende System zum Abruf bereit.
--
GitLab