Skip to content
Snippets Groups Projects
Verified Commit 99a25fc6 authored by Jonas Gröger's avatar Jonas Gröger :palm_tree:
Browse files

feat(FCON-189): rename 'schemas' to 'submissionSchemas'

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
parent 0096aca0
No related branches found
No related tags found
1 merge request!7feat(FCON-189): rename 'schemas' to 'submissionSchemas'
......@@ -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.
......
......@@ -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"
......@@ -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"
......
......@@ -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"
],
......
......@@ -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"
......
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment