From 96391bb66b4c5272a3b0c57600795f82ae867245 Mon Sep 17 00:00:00 2001
From: Jonas Groeger <jonas.groeger@codecentric.de>
Date: Sun, 8 Aug 2021 17:57:16 +0200
Subject: [PATCH] feat(FCON-189): rename 'schemas' to 'submission_schema'
this rename is done to have a more specific name for the field. just
having the generic word 'schema' might be confusing.
Fixes https://git.fitko.de/fit-connect/api/-/issues/83
---
docs/changelog.md | 12 ++++++------
docs/details/schema-reference.md | 8 ++++----
docs/getting-started/receiving/destination.mdx | 2 +-
docs/getting-started/sending/get-destination.mdx | 8 +++++---
4 files changed, 16 insertions(+), 14 deletions(-)
diff --git a/docs/changelog.md b/docs/changelog.md
index 45866c8dc..8ad913b02 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 `submission_schema` 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": [
+ "submission_schema": [
{
"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`
+- `submission_schema`
+- `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 e85c35ae2..10e28be0b 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 `submission_schema` eine Liste von Fachschemareferenzen:
```json
- "schemas": [
+ "submission_schema": [
{
"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": [
+ "submission_schema": [
{
"schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json",
"mimeType": "application/json"
@@ -187,7 +187,7 @@ GET /destinations/{destinationId}
```json
{
- "schemas": [
+ "submission_schema": [
{
"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 9f6169050..31c1b0a03 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": [
+ "submission_schema": [
"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 77a0833aa..d865e4df7 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 (`submission_schema`): 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": [
+ "submission_schema": [
{
"schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.xsd",
"mimeType": "application/xml"
--
GitLab