Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update JSON schemas #95

Merged
merged 2 commits into from
Feb 11, 2025
Merged

chore: update JSON schemas #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4020526
chore: update JSON schemas
Feb 10, 2025
df1774f
Update domain-specific-terms.txt
hf-kklein Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions domain-specific-terms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ paket
beginn
referenz
alle
ende
tages
90 changes: 50 additions & 40 deletions json_schemas/Anwendungshandbuch.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
{
"$defs": {
"Anwendungsfall": {
"description": "One Anwendungsfall \"AWF\" corresponds to one Prüfidentifikator or Type of Message",
"description": "One 'Anwendungsfall', indicated by `<AWF>` tag, corresponds to one Prüfidentifikator or type of Message",
"properties": {
"beschreibung": {
"title": "Beschreibung",
"type": "string"
},
"elements": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Segment"
},
{
"$ref": "#/$defs/SegmentGroup"
}
]
},
"title": "Elements",
"type": "array"
},
"format": {
"title": "Format",
"type": "string"
Expand All @@ -18,29 +32,14 @@
"pruefidentifikator": {
"title": "Pruefidentifikator",
"type": "string"
},
"segment_groups": {
"items": {
"$ref": "#/$defs/SegmentGroup"
},
"title": "Segment Groups",
"type": "array"
},
"segments": {
"items": {
"$ref": "#/$defs/Segment"
},
"title": "Segments",
"type": "array"
}
},
"required": [
"pruefidentifikator",
"beschreibung",
"kommunikation_von",
"format",
"segments",
"segment_groups"
"elements"
],
"title": "Anwendungsfall",
"type": "object"
Expand All @@ -65,7 +64,7 @@
"type": "object"
},
"Code": {
"description": "a single code element inside an AHB DataElement",
"description": "A single code element inside an AHB DataElement, indicated by the `<Code>` tag.",
"properties": {
"ahb_status": {
"title": "Ahb Status",
Expand Down Expand Up @@ -108,8 +107,19 @@
"type": "object"
},
"DataElement": {
"description": "A single data element inside a AHB Segment.\nThis models both the 'Datenelement' and the 'Gruppendatenelement'",
"description": "A single data element, German 'Datenelement' inside an AHB Segment, indicated by the `<D_xxxx>` tag.\nThis element can contain a single or multiple Code elements.",
"properties": {
"ahb_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ahb Status"
},
"codes": {
"items": {
"$ref": "#/$defs/Code"
Expand All @@ -129,13 +139,14 @@
"required": [
"id",
"name",
"ahb_status",
"codes"
],
"title": "DataElement",
"type": "object"
},
"DataElementGroup": {
"description": "a group of data elements, German 'Datenelementgruppe' inside the AHB",
"description": "A group of data elements, German 'Datenelementgruppe' inside the AHB, indicated by the `<C_xxxx>` tag.\nThis model can contain both the 'Datenelement' and the 'Gruppendatenelement'",
"properties": {
"data_elements": {
"items": {
Expand Down Expand Up @@ -181,7 +192,7 @@
"type": "object"
},
"Segment": {
"description": "a segment inside an AHB",
"description": "A segment inside an AHB, indicated by the `<S_xxxx>` tag.\nThis model can contain both data elements and data element groups.",
"properties": {
"ahb_status": {
"anyOf": [
Expand Down Expand Up @@ -232,7 +243,7 @@
"type": "object"
},
"SegmentGroup": {
"description": "a \"Segmentgruppe\" inside an AHB",
"description": "A 'Segmentgruppe' inside an AHB, indicated by the `<G_xxxx>` tag.\nThis model can contain both Segments and segment groups.",
"properties": {
"ahb_status": {
"anyOf": [
Expand All @@ -245,35 +256,34 @@
],
"title": "Ahb Status"
},
"elements": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Segment"
},
{
"$ref": "#/$defs/SegmentGroup"
}
]
},
"title": "Elements",
"type": "array"
},
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"segment_groups": {
"items": {
"$ref": "#/$defs/SegmentGroup"
},
"title": "Segment Groups",
"type": "array"
},
"segments": {
"items": {
"$ref": "#/$defs/Segment"
},
"title": "Segments",
"type": "array"
}
},
"required": [
"id",
"name",
"ahb_status",
"segments",
"segment_groups"
"elements"
],
"title": "SegmentGroup",
"type": "object"
Expand All @@ -298,7 +308,7 @@
"type": "object"
}
},
"description": "Ein Anwendungshandbuch bündelt verschiedene Nachrichtentypen/Anwendungsfälle im selben Format oder mit der selben\nregulatorischen Grundlage und stellt gemeinsame Pakete & Bedingungen bereit.",
"description": "Ein Anwendungshandbuch, indicated by the `<AHB` tag, bündelt verschiedene Nachrichtentypen/Anwendungsfälle im\nselben Format oder mit der selben regulatorischen Grundlage und stellt gemeinsame Pakete & Bedingungen bereit.",
"properties": {
"anwendungsfaelle": {
"items": {
Expand Down Expand Up @@ -353,4 +363,4 @@
],
"title": "Anwendungshandbuch",
"type": "object"
}
}
75 changes: 37 additions & 38 deletions json_schemas/MessageImplementationGuide.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$defs": {
"Code": {
"description": "a single code element inside a MIG Dataelement",
"description": "A single code element inside a MIG data element, indicated by the `<Code>` tag.",
"properties": {
"description": {
"anyOf": [
Expand Down Expand Up @@ -39,7 +39,7 @@
"type": "object"
},
"DataElement": {
"description": "A single data element inside a MIG Segment.\nThis models both the 'Datenelement' and the 'Gruppendatenelement'",
"description": "A single data element inside a MIG Segment.\nThis models both the 'Datenelement' and the 'Gruppendatenelement', indicated by the `<D_xxxx` tag.\nAre able to contain a single or multiple Code elements.",
"properties": {
"codes": {
"items": {
Expand Down Expand Up @@ -96,7 +96,7 @@
"type": "object"
},
"DataElementGroup": {
"description": "a group of data elements, German 'Datenelementgruppe'.",
"description": "A group of data elements, German 'Datenelementgruppe', indicated by the `<C_xxxx>` tag.\nAre able to contain a single or multiple data elements.",
"properties": {
"data_elements": {
"items": {
Expand Down Expand Up @@ -149,13 +149,14 @@
"C",
"R",
"N",
"D"
"D",
"O"
],
"title": "MigStatus",
"type": "string"
},
"Segment": {
"description": "a segment inside a MIG",
"description": "A segment inside a MIG, indicated by the `<S_xxxx>` tag. A segment contains data elements and data element groups.",
"properties": {
"counter": {
"title": "Counter",
Expand Down Expand Up @@ -246,12 +247,26 @@
"type": "object"
},
"SegmentGroup": {
"description": "a \"Segtmentgruppe\"",
"description": "A 'Segmentgruppe' inside a MIG, indicated by the `<G_xxx>` tag. A segment contains segments and segments groups.",
"properties": {
"counter": {
"title": "Counter",
"type": "string"
},
"elements": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Segment"
},
{
"$ref": "#/$defs/SegmentGroup"
}
]
},
"title": "Elements",
"type": "array"
},
"id": {
"title": "Id",
"type": "string"
Expand All @@ -272,20 +287,6 @@
"title": "Name",
"type": "string"
},
"segment_groups": {
"items": {
"$ref": "#/$defs/SegmentGroup"
},
"title": "Segment Groups",
"type": "array"
},
"segments": {
"items": {
"$ref": "#/$defs/Segment"
},
"title": "Segments",
"type": "array"
},
"status_specification": {
"$ref": "#/$defs/MigStatus"
},
Expand All @@ -302,8 +303,7 @@
"max_rep_specification",
"status_std",
"status_specification",
"segments",
"segment_groups"
"elements"
],
"title": "SegmentGroup",
"type": "object"
Expand All @@ -315,23 +315,23 @@
"title": "Autor",
"type": "string"
},
"format": {
"title": "Format",
"type": "string"
},
"segment_groups": {
"elements": {
"items": {
"$ref": "#/$defs/SegmentGroup"
"anyOf": [
{
"$ref": "#/$defs/Segment"
},
{
"$ref": "#/$defs/SegmentGroup"
}
]
},
"title": "Segment Groups",
"title": "Elements",
"type": "array"
},
"segments": {
"items": {
"$ref": "#/$defs/Segment"
},
"title": "Segments",
"type": "array"
"format": {
"title": "Format",
"type": "string"
},
"veroeffentlichungsdatum": {
"format": "date",
Expand All @@ -348,9 +348,8 @@
"autor",
"versionsnummer",
"format",
"segments",
"segment_groups"
"elements"
],
"title": "MessageImplementationGuide",
"type": "object"
}
}