diff --git a/docs/changelog.md b/docs/changelog.md index 45866c8dc5c8d537de94718a1a23000525f20d18..77385e3867540d6ae8400172319da834740ed156 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -29,7 +29,7 @@ Der Aufbau & Umfang von Destination-Objekten hat sich geändert: - Die Attribute `callback` und `callbackURI` wurden zusammengeführt, - um die Struktur flacher zu gestalten, - und weil neben `callbackURI` keine anderen Attribute angeordnet sind. -- Im Attribut `schemas` entfällt das Attribut `encoding`, +- Im Attribut `submissionSchemas` entfällt das Attribut `encoding`, - da ab Version 1 jede Kommunikation Ende-zu-Ende verschlüsselt sein muss. - Das Attribut `publicKey` wurde umbenannt zu `encryptionKid`. Weiterhin wurde ein Feld `keys` eingefügt. - `encryptionKid`: Die KeyId des Schlüssels der zur Verschlüsselung der an einen Zustellpunkt gesendeten Daten @@ -49,7 +49,7 @@ Der Aufbau & Umfang von Destination-Objekten hat sich geändert: "email": "max@mustermann.not", "unit": "Musterabteilung XYZ" }, - "schemas": [ + "submissionSchemas": [ { "schemaURI": "urn:xoev-de:xfall:standard:fim-s00000000009_1.0.0", "mimeType": "application/xml" @@ -66,10 +66,10 @@ Der Aufbau & Umfang von Destination-Objekten hat sich geändert: ##### Get Destination -- destinationId -- schemas -- encryptionKid -- keys +- `destinationId` +- `submissionSchemas` +- `encryptionKid` +- `keys` Das Attribut `contact` (vormals `technicalContact`) wird nicht mehr zurückgegeben, da dies schützenswerte Informationen sind. diff --git a/docs/details/schema-reference.md b/docs/details/schema-reference.md index e85c35ae28742bad3e0975abc3d102d73710fbdd..8c85bed1ac7e1340da60dbad9fc1e0ee0ea5d745 100644 --- a/docs/details/schema-reference.md +++ b/docs/details/schema-reference.md @@ -79,10 +79,10 @@ Die schemaURI wird wie folgt gebildet: ### Fachschemareferenz(en) im Zustellpunkt -Der Zustellpunkt enthält ein Array "schemas", das eine Liste von Fachschemareferenzen enthält. +Der Zustellpunkt enthält im Feld `submissionSchemas` eine Liste von Fachschemareferenzen: ```json - "schemas": [ + "submissionSchemas": [ { "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json", "mimeType": "application/json" @@ -109,7 +109,7 @@ Sofern der Zustellpunkt mindestens eine Fachschemareferenz enthält, muss der Me ```json "contentStructure": { "data": { - "schema": { + "submissionSchemas": { "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json", "mimeType": "application/json" } @@ -141,7 +141,7 @@ POST /destinations "email": "max@mustermann.not", "unit": "Department XYZ" }, - "schemas": [ + "submissionSchemas": [ { "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json", "mimeType": "application/json" @@ -187,7 +187,7 @@ GET /destinations/{destinationId} ```json { - "schemas": [ + "submissionSchemas": [ { "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json", "mimeType": "application/json" diff --git a/docs/getting-started/receiving/destination.mdx b/docs/getting-started/receiving/destination.mdx index 9f6169050fd4f1a7cc5f7136bb221565fe95cdbf..f0fe3a0df8f6904ca4886be39a2d9c614be3e377 100644 --- a/docs/getting-started/receiving/destination.mdx +++ b/docs/getting-started/receiving/destination.mdx @@ -66,7 +66,7 @@ $ curl \ "services": [ { "identifier": "urn:xoev-de:xfall:standard:fim-s00000000009_1.0.0", - "schemas": [ + "submissionSchemas": [ "schemaUri": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json", "mimeType": "application/json" ], diff --git a/docs/getting-started/sending/get-destination.mdx b/docs/getting-started/sending/get-destination.mdx index 77a0833aa5f27dc8b30cce26b70571ab5a652b0a..072ad2dfac6b0f330cfd5d879a06bcd67af21f58 100644 --- a/docs/getting-started/sending/get-destination.mdx +++ b/docs/getting-started/sending/get-destination.mdx @@ -12,8 +12,10 @@ Um eine Einreichung an die fachlich korrekte Stelle sicherzustellen und die tech ## Informationen des Zustellpunktes erhalten -Um an einen Zustellpunkt eine Einreichung korrekt zu übermitteln, ist es notwendig, die im Zustellpunkt hinterlegten technischen Parameter für die Einreichung zu ermitteln. Diese Informationen sind: -- Die zulässigen Fachdatenschemata (`schemas`): Hiermit legt das empfangende System fest, welchem Schema die übergebenen Fachdatensätze entsprechen müssen. Welches der dort angebenen Schemata verwendet werden muss, muss das sendende System aus dem eigenen fachlichen Kontext heraus bestimmen. Wenn bspw. ein Antrag für einen Schwerbehindertenausweis gestellt wird, muss der Fachdatensatz aus den dort hinterlegten Schemata gemäß dem dortigen Schema für den Schwerbehindertausweis (bspw. ein FIM/XFall Schema) entsprechen. +Um an einen Zustellpunkt eine Einreichung korrekt zu übermitteln, ist es notwendig, die im Zustellpunkt hinterlegten technischen Parameter für die Einreichung zu ermitteln. +Diese Informationen sind: +- Die zulässigen Fachdatenschemata (`submissionSchemas`): Hiermit legt das empfangende System fest, welchem Schema die übergebenen Fachdatensätze entsprechen müssen. +Welches der dort angebenen Schemata verwendet werden muss, muss das sendende System aus dem eigenen fachlichen Kontext heraus bestimmen. Wenn bspw. ein Antrag für einen Schwerbehindertenausweis gestellt wird, muss der Fachdatensatz aus den dort hinterlegten Schemata gemäß dem dortigen Schema für den Schwerbehindertausweis (bspw. ein FIM/XFall Schema) entsprechen. - Der öffentliche Verschlüsselungsschlüssel (`kid` und `publicKeys`): Empfangende Systeme veröffentlichen in Form eines JSON Web Key Sets einen oder mehrere Public Keys für die Verschlüsselung der Einreichung. Welcher Public Key zum aktuellen Zeitpunkt für die Verschlüsselung genutzt werden muss, wird über den `kid` Parameter mitgeteilt. Hierzu stellt die Submission API einen Endpunkt bereit, der über den `destinationId` Parameter die technischer Parameter der Einreichung für den jeweiligen Zustellpunkt ausgibt. @@ -39,7 +41,7 @@ $ curl \ > { "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047", - "schemas": [ + "submissionSchemas": [ { "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.xsd", "mimeType": "application/xml" diff --git a/docs/getting-started/sending/metadata.mdx b/docs/getting-started/sending/metadata.mdx index 2f1edf49762adef6f83bcc67485ecf76e2b61c09..cb7dab2a208a04f9fe5bd6070f6cc3e803bd16e5 100644 --- a/docs/getting-started/sending/metadata.mdx +++ b/docs/getting-started/sending/metadata.mdx @@ -32,7 +32,7 @@ Ein Beispiel für das Metadatenschema eines Kindergeldantrags ist unten dargeste ], "contentStructure": { "data": { - "schema": { + "submissionSchemas": { "schemaSource": "fim", "mimeType": "application/json" } diff --git a/docs/more/glossary.md b/docs/more/glossary.md index 28b761eb8de2a75165aeac1b1c0107a7ee0478be..34114733ffbcad627776268dd4ab1cf714ad2c31 100644 --- a/docs/more/glossary.md +++ b/docs/more/glossary.md @@ -18,7 +18,7 @@ hide_table_of_contents: true | Ereignis (event) | Als [Security Event Token](https://datatracker.ietf.org/doc/html/rfc8417) aufgezeichnetes Ereignis eines im Zustelldienst abgelegten Objekts. Dies kann z.B. das Absenden einer Einreichung sein. | | Ereignisprotokoll (event log) | Der Zustelldienst bündelt alle einem Object zugeordneten Ereignisse in einem Ereignisprotokoll. | | Fachdatensatz (data) | Ist ein strukturierter Fachdatensatz im Rahmen der Einreichung. Kann JSON, XML oder ein anderes in verwaltungseigenen Datenstandards genutztes Datenformat sein. | -| Fachschemareferenz (schema) | Das referenzierte Fachschema aus FIM oder XÖV. Eine Liste der möglichen Fachschemata wird im Zustellpunkt angegeben. Das verwendete Fachschema steht im Metadatensatz. | +| Fachschemareferenz (submission schema) | Das referenzierte Fachschema aus FIM oder XÖV. Eine Liste der möglichen Fachschemata wird im Zustellpunkt angegeben. Das verwendete Fachschema steht im Metadatensatz. | | Kommunikationskanal (communication channel) | Beschreibt einen Kommunikationskanal, um zwischen der zuständigen Stelle und dem Autor der Einreichung (bspw. dem Verwaltungskund:in) zu digital zu kommunizieren.<br/>Kommunikationskanäle können sein:<br/>- E-Mail<br/>- De-Mail<br/>- FIT-Connect Rückkanal<br/>- Interoperable Postfächer FINK (AS4)<br />- Elster Transfer des einheitlichen Unternehmenskontos<br />- Postfachplus (OSCI) des einheitlichen Unternehmenskontos<br />Eine zuständige Stelle kommuniziert über die Destination, welche Kommunikationskanäle unterstützt werden und der Autor der Einreichung legt fest, welche Kommunikationskanäle er sich hierfür wünscht. Für die Adressierung des Autors werden alle für den Kommunikationskanal notwendigen Verbindungs- und Adressparameter (einschließlich ggf. notwendiger Schlüssel/Zertifikate) im Metadatensatz mitgeliefert.| | Metadatensatz (metadata) | Ein Metadatensatz beschreibt:<br/>- Fachunabhängige Metadaten der Einreichung: Authentifizierung des Autors einer Einreichung oder Berichts (bspw. über einen eID-Laufzettel, Identifikation Report, Informationen über Signaturnutzung einschließlich Angabe des Signaturformats und ggf. separater Signaturdateien.), Ergebnisse eines Bezahlvorgangs oder digitale Verbindungs- und Adressparameter für die Verfahrensinformationen (falls vom Verwaltungskund:in gewünscht).<br/>- Strukturbeschreibung der Einreichung: Art der Leistung oder Einreichungsbestandteile. | | Autorisierungsdienst | Der Autorisierungsdienst / OAuth-Dienst stellt via Client-Credentials-Flow OAuth-Tokens an API-Clients aus, mit denen diese sich anschließend gegenüber den Zustelldienst APIs (d.h. gegenüber dem API-Gateway) authentifizieren können. | diff --git a/news/sprint-report-cw-30.md b/news/sprint-report-cw-30.md index 643b5e0568740146a32949a80bcb52179a4d9aaf..d5972912580509f520a49b88ba24a2a150ae1d6b 100644 --- a/news/sprint-report-cw-30.md +++ b/news/sprint-report-cw-30.md @@ -84,10 +84,10 @@ werden kann. Die Implementierung des neuen Statusmodells wurde im Rahmen der Umbauten durch den Event Log abgeschlossen und muss im Rahmen dieser noch mit dokumentiert werden. -#### `schema` in `submissionSchema` umbenennen +#### `schema` in `submissionSchemas` umbenennen Als Follow-Up aus einem vorherigen Sprint wurde beschlossen, dass der technische Bezeichner der "Fachschemareferenz" -an verschiedensten Stellen von `schema` zu `submissionSchema` geändert wird. +an verschiedensten Stellen von `schema` zu `submissionSchemas` geändert wird. Die Umsetzung hiervon konnte noch nicht begonnen werden und wird daher in einem der nächsten Sprints angegangen.