schemaId durch schemaUri ersetzen

Zur Identifizierung von verwendeten Schemas sollten URLs verwendet werden. Durch die Verwendung von URIs können sowohl URLs in einem Schema-Repository (z.B. https://schema.fimportal.de/fim/fim.S00000147.00000147001002.xml), als auch URNs abgebildet werden (z.B. urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200).

- "schemaId": {
-   "type": "string",
-   "description": "ID des Schemas, abhängig von der ausgewählten Quelle."
- },
- "schemaSource": {
-   "type": "string",
-   "enum": [
-     "fim",
-     "none"
-   ],
-   "description": "Quelle, von der das Schema bezogen werden kann."
- },
+ "schemaUri": {
+   "type": "string",
+   "format": "uri",
+   "description": "Referenz-URI auf das Schemas (XML-Schema oder JSON-Schema)"
+ },

siehe https://git.fitko.de/fit-connect/FIT-Connect-PoC/-/blob/develop/models/application/schema.json

• Für die Schama-Referenzierung sind geeignete Beispiele zu erstellen. (siehe #53 (closed))

marked this issue as related to #53 (closed)

marked this issue as related to #46 (closed)

changed title from schemaId durch schemaUrl ersetzen to schemaId durch schemaUri ersetzen

changed the description

Die Nutzung einer URI für schemaId finde ich gut. Wenn wir den schemaSource wegfallen lassen, dann muss ein nutzendes System diese indirekt aus der Struktur der schemaURI ermitteln. Also z.B.

• urn:xoev-de: -> XRepository REST API
• https:// -> URL aufrufen

Was passiert aber, wenn ein System eingebunden wird, dass zwar URLs verwendet, diese jedoch auf eine Doku-Seite und nicht auf das XSD zeigen?

Beispiel: Der Namespace von Genericode ist http://docs.oasis-open.org/codelist/ns/genericode/1.0/, bezogen wird das Schema aber unter http://docs.oasis-open.org/codelist/genericode/xsd/genericode.xsd.

Daher würde ich vorschlagen, dass wir bei zwei Angaben bleiben:

• schemaId ist eine URI die den Namespace bzw. die ID des Schemas benennt.
• schemaLocation ist eine URL, unter der das Schema bezogen werden kann.

Das empfangende System wird das Schema vermutlich kennen, aber ein vermittelndes System (virtuelle Poststelle, Gateway etc.) müsste eine manuell gepflegte Liste alles Schemas vorhalten. Ist das gewollt?

marked this issue as related to #54 (closed)

Empfangende Systeme haben typischerweise ja eine feste Zahl an zulässigen Schema und kennen die von ihnen unterstützten Schema ja. Mir ist nicht ganz klar, warum vermittelnde Systeme eine manuell gepflegte Liste aller Schemata vorhalten müssten? Anhand der schemaURI können vermittelnde Systeme die Schemata ja im Zweifel bei Bedarf nachladen.

Die Problematik der Verlinkung von Dokumentations-Seiten würe in der Tat zu einem Fehler führen. Hier sollten wir entweder durch eine eindeutige description und entsprechende Beispiele oder durch ein zusätzliches Attribut schemaDocumentationUrl klar machen, dass hier das Schema und nicht die Dokumentation verlinkt werden soll:

"schemaUri": {
  "type": "string",
  "format": "uri",
  "description": "Entweder eine Schema-URN oder eine Schema-URL, unter der das Schema abgerufen werden kann (xsd- oder JSON-Schema-Datei)"
},
"schemaDocumentationUrl": {
  "type": "string",
  "format": "uri",
  "description": "Link zu Entwickler:innendokumentation zum verwendeten Schema (z.B. Dokumentationswebseite oder PDF-Datei)"
}

Da die schemaUri (== schemaLocation) ein Schema bereits eindeutig identifiziert, würde ich von der zusätzlichen Angabe einer schemaId absehen.

Der Punkt ist, dass ein Schema eine Kennung (URI) hat und ein Adresse (URL), von der es geladen werden kann. Und die beiden sind oft nicht identisch. Daher sollte es bei zwei Angaben bleiben. Entweder ID und Quelle (wie bisher) oder ID und Adresse.

Ich kann gerade nicht ganz folgen. Eine URI ist immer entweder eine URN oder eine URL. Beide ermöglichen einen Abruf des Schemas aus dem entsprechenden Repository.

added 1 deleted label

mentioned in issue #53 (closed)

Ich sehe hier 2 Optionen:

• Name und Ort des Schemas trennen
• Name so schreiben dass er dereferenzierbar ist (HTTP-Anfrage oder ein zentraler dokumentierter Ort)

Vorschlag: Wenn der Name mit urn: beginnt ist er hier im Repository zu finden. Sonst an der URL.

changed the description

mentioned in commit f3057b88

mentioned in merge request !24 (merged)

marked the checklist item Für die Schama-Referenzierung sind geeignete Beispiele zu erstellen. (siehe #53 (closed)) as completed

closed