From 52109ce99a00650f2ad631a82cd7b50e0d36314f Mon Sep 17 00:00:00 2001
From: Jonas Groeger <jonas.groeger@codecentric.de>
Date: Wed, 3 Nov 2021 10:19:19 +0100
Subject: [PATCH] feat(214): rename schemaURI to schemaUri
See https://git.fitko.de/fit-connect/planning/-/issues/214
---
docs/changelog.md | 6 +++---
docs/details/schema-reference.md | 14 +++++++-------
docs/getting-started/metadata.md | 2 +-
docs/getting-started/receiving/validate.mdx | 14 +++++++-------
docs/getting-started/sending/get-destination.mdx | 4 ++--
docs/getting-started/sending/metadata.mdx | 2 +-
docs/getting-started/submission-structure.mdx | 10 +++++-----
7 files changed, 26 insertions(+), 26 deletions(-)
diff --git a/docs/changelog.md b/docs/changelog.md
index 77385e386..d587ded0b 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -37,8 +37,8 @@ Der Aufbau & Umfang von Destination-Objekten hat sich geändert:
- `keys`: Hier befinden sich die öffentlichen Schlüssel des Zustellpunktes.
- Der `signingKid` fehlt, da dieser an signierten Nachrichten mit angehängt wird und ebenso im Attribut `keys`
auffindbar ist.
-- Ein Schema besteht nun aus einer `schemaURI` und einem `mimeType`.
- - Wurde im Zuge der Vereinfachung so umgesetzt. URLs und URNs können in das Feld `schemaURI` eingetragen werden.
+- Ein Schema besteht nun aus einer `schemaUri` und einem `mimeType`.
+ - Wurde im Zuge der Vereinfachung so umgesetzt. URLs und URNs können in das Feld `schemaUri` eingetragen werden.
```json
{
@@ -51,7 +51,7 @@ Der Aufbau & Umfang von Destination-Objekten hat sich geändert:
},
"submissionSchemas": [
{
- "schemaURI": "urn:xoev-de:xfall:standard:fim-s00000000009_1.0.0",
+ "schemaUri": "urn:xoev-de:xfall:standard:fim-s00000000009_1.0.0",
"mimeType": "application/xml"
}
],
diff --git a/docs/details/schema-reference.md b/docs/details/schema-reference.md
index 54a4c826f..d98da7cc1 100644
--- a/docs/details/schema-reference.md
+++ b/docs/details/schema-reference.md
@@ -12,7 +12,7 @@ und gerne schon einen konkreten Vorschlag zuliefern.
## Aufbau Fachschemareferenz
Eine Fachschemareferenz besteht aus zwei Angaben.
-- Die `schemaURI` referenziert das zu verwendende Fachschema.
+- Die `schemaUri` referenziert das zu verwendende Fachschema.
- Der `mimeType` gibt den Datentyp (JSON oder XML) der Fachdaten vor.
Bitte beachten Sie, dass manche Fachschema nur JSON oder XML als Datentyp zulassen.
@@ -25,10 +25,10 @@ Um ein FIM Fachschema eindeutig zu referenzieren sind folgende Angaben notwendig
- **Version** des Stammdatenschemas ("1.0.0" im Beispiel)
- **Art** des Schemas (JSON oder XML Schema)
-Für ein JSON Schema wird die schemaURI wird wie folgt gebildet:
+Für ein JSON Schema wird die schemaUri wird wie folgt gebildet:
`https://schema.fitko.de/fim/{ID}_{Version}.schema.json`
-Für ein XML Schema wird die schemaURI wird wie folgt gebildet:
+Für ein XML Schema wird die schemaUri wird wie folgt gebildet:
`https://schema.fitko.de/fim/{ID}_{Version}.xsd`
### Beispiel für eine FIM Fachschemareferenz
@@ -36,7 +36,7 @@ Für ein XML Schema wird die schemaURI wird wie folgt gebildet:
JSON Schema:
```json
{
- "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json",
+ "schemaUri": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json",
"mimeType": "application/json"
}
```
@@ -44,7 +44,7 @@ JSON Schema:
XML Schema:
```json
{
- "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.xsd",
+ "schemaUri": "https://schema.fitko.de/fim/s00000000009_1.0.0.xsd",
"mimeType": "application/xml"
}
```
@@ -58,14 +58,14 @@ Ein XÖV Fachschema wird über folgende Angaben referenziert:
Beispiel: `urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200`
-Die schemaURI wird wie folgt gebildet:
+Die schemaUri wird wie folgt gebildet:
`{Kennung}_{Version}#{Nachricht}`
### Beispiel für eine XÖV Fachschemareferenz
```json
{
- "schemaURI": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
+ "schemaUri": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
"mimeType": "application/xml"
}
```
diff --git a/docs/getting-started/metadata.md b/docs/getting-started/metadata.md
index a14fd20de..bbf69aa36 100644
--- a/docs/getting-started/metadata.md
+++ b/docs/getting-started/metadata.md
@@ -65,7 +65,7 @@ Fachdaten, beschrieben.
"contentStructure": {
"data": {
"schema": {
- "schemaURI": "urn:de:fim:leika:leistung:99015004037000",
+ "schemaUri": "urn:de:fim:leika:leistung:99015004037000",
"mimeType": "application/json"
}
},
diff --git a/docs/getting-started/receiving/validate.mdx b/docs/getting-started/receiving/validate.mdx
index 198b63284..64d29e220 100644
--- a/docs/getting-started/receiving/validate.mdx
+++ b/docs/getting-started/receiving/validate.mdx
@@ -40,14 +40,14 @@ Die Fachschemareferenz gibt an, welches Schema zu beziehen ist.
"contentStructure": {
"data": {
"schema": {
- "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json",
+ "schemaUri": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json",
"mimeType": "application/json"
}
}
}
```
-- Prüfen Sie, dass die `schemaURI` mit `https://schema.fitko.de/fim/` beginnt. Dies stellt sicher, dass das Fachschema aus dem FITKO Repository bezogen wird.
+- Prüfen Sie, dass die `schemaUri` mit `https://schema.fitko.de/fim/` beginnt. Dies stellt sicher, dass das Fachschema aus dem FITKO Repository bezogen wird.
- Laden Sie das Fachschema herunter
```
@@ -65,14 +65,14 @@ Zukünftig werden sie auch über das FITKO Schemarepository zur Verfügung stehe
"contentStructure": {
"data": {
"schema": {
- "schemaURI": "https://schema.fitko.de/fim/s00000092_1.0.xsd",
+ "schemaUri": "https://schema.fitko.de/fim/s00000092_1.0.xsd",
"mimeType": "application/xml"
}
}
}
```
-- Prüfen Sie, dass die `schemaURI` mit `https://schema.fitko.de/fim/` beginnt.
+- Prüfen Sie, dass die `schemaUri` mit `https://schema.fitko.de/fim/` beginnt.
- Entnehmen Sie der URI die ID des Fachschemas (hier: "s00000092").
- Öffnen Sie das FIM-Portal (https://fimportal.de/) und loggen Sie sich ein.
- Öffnen Sie Sie Adresse `https://fimportal.de/detail/D/{ID}`, also z.B. https://fimportal.de/detail/D/S00000092.
@@ -84,7 +84,7 @@ Zukünftig werden sie auch über das FITKO Schemarepository zur Verfügung stehe
Die XÖV Standards werden im [XRepository](https://www.xrepository.de/) abgelegt.
Auf die Inhalte des XRepository kann über eine [REST-API](https://www.xrepository.de/cms/hilfe.html#rest-api) zugegriffen werden.
-Entnehmen Sie der Fachschemareferenz die Angabe `schemaURI`. Diese besteht aus zwei durch ein Doppelkreuz (#) getrennten Teilen. Vor dem Doppelkreuz steht die Kennung, dahinter der Name der Nachricht.
+Entnehmen Sie der Fachschemareferenz die Angabe `schemaUri`. Diese besteht aus zwei durch ein Doppelkreuz (#) getrennten Teilen. Vor dem Doppelkreuz steht die Kennung, dahinter der Name der Nachricht.
Um z.B. einen Bauantrag zu prüfen, gehen Sie wie folgt vor.
- Im Metadatensatz finden Sie folgende Fachschemareferenz.
@@ -92,14 +92,14 @@ Um z.B. einen Bauantrag zu prüfen, gehen Sie wie folgt vor.
"contentStructure": {
"data": {
"schema": {
- "schemaURI": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
+ "schemaUri": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
"mimeType": "application/xml"
}
}
}
```
-- Die `schemaURI` enthält folgende Angaben:
+- Die `schemaUri` enthält folgende Angaben:
- Kennung: `urn:xoev-de:bmk:standard:xbau_2.2`
- Nachrichtenname `baugenehmigung.antrag.0200`
- Laden Sie das XML Schema herunter und entpacken Sie es.
diff --git a/docs/getting-started/sending/get-destination.mdx b/docs/getting-started/sending/get-destination.mdx
index 35e023232..ad71508a4 100644
--- a/docs/getting-started/sending/get-destination.mdx
+++ b/docs/getting-started/sending/get-destination.mdx
@@ -71,7 +71,7 @@ Beispiel für die Response:
"status": "active",
"submissionSchemas": [
{
- "schemaURI": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
+ "schemaUri": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
"mimeType": "application/xml"
}
],
@@ -155,7 +155,7 @@ $ curl \
"identifier": "urn:de:fim:leika:leistung:99010003001006",
"submissionSchemas": [
{
- "schemaURI": "https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
+ "schemaUri": "https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
"mimeType": "application/json"
}
],
diff --git a/docs/getting-started/sending/metadata.mdx b/docs/getting-started/sending/metadata.mdx
index b164b11eb..d69481650 100644
--- a/docs/getting-started/sending/metadata.mdx
+++ b/docs/getting-started/sending/metadata.mdx
@@ -33,7 +33,7 @@ Ein Beispiel für das Metadatenschema eines Kindergeldantrags ist unten dargeste
"contentStructure": {
"data": {
"submissionSchema": {
- "schemaURI": "urn:de:fim:leika:leistung:a38",
+ "schemaUri": "urn:de:fim:leika:leistung:a38",
"mimeType": "application/json"
}
},
diff --git a/docs/getting-started/submission-structure.mdx b/docs/getting-started/submission-structure.mdx
index 1180e71f7..f477f9c97 100644
--- a/docs/getting-started/submission-structure.mdx
+++ b/docs/getting-started/submission-structure.mdx
@@ -26,7 +26,7 @@ Dieser enthält Strukturinformationen zum Fachdatensatz und Anlagen sowie prozes
In der Submission API wird durch das empfangende System über eine Schemareferenz im Zustellpunkt ein konkretes Schema für den Fachdatensatz festgelegt, den das sendende System übersenden darf. Eine Fachschemareferenz besteht aus zwei Angaben:
-- Die `schemaURI` referenziert das zu verwendende Fachschema.
+- Die `schemaUri` referenziert das zu verwendende Fachschema.
- Der `mimeType` gibt den Datentyp (JSON oder XML) des Fachdatensatzes vor.
In den Angaben eines Zustellpunkts befindet sich die Fachschemareferenz immer innerhalb eines Service-Objekts innerhalb des `services` Arrays.
@@ -38,7 +38,7 @@ Die Fachschemareferenz ist im Zustellpunkt daher immer einer dazugehörigen Leis
"identifier":"urn:de:fim:leika:leistung:99010003001006",
"submissionSchemas":[
{
- "schemaURI":"https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
+ "schemaUri":"https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
"mimeType":"application/json"
}
],
@@ -51,11 +51,11 @@ Die Fachschemareferenz ist im Zustellpunkt daher immer einer dazugehörigen Leis
...
"submissionSchemas":[
{
- "schemaURI":"https://schema.fitko.de/fim/s00000000009_1.1.0.schema.json",
+ "schemaUri":"https://schema.fitko.de/fim/s00000000009_1.1.0.schema.json",
"mimeType":"application/json"
},
{
- "schemaURI":"https://schema.fitko.de/fim/s00000000010_1.0.0.schema.json",
+ "schemaUri":"https://schema.fitko.de/fim/s00000000010_1.0.0.schema.json",
"mimeType":"application/json"
}
],
@@ -78,7 +78,7 @@ Zusätzlich muss das sendende System eine identische Fachschemareferenz in den M
"contentStructure": {
"data": {
"submissionSchema": {
- "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json",
+ "schemaUri": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json",
"mimeType": "application/json"
}
}
--
GitLab