Skip to content

Commit c98fa4c

Browse files
hf-kkleinKonstantin
hf-kklein
and
Konstantin
authored
chore: update JSON schemas (#95)
--------- Co-authored-by: Konstantin <[email protected]>
1 parent 74e410b commit c98fa4c

3 files changed

+89
-78
lines changed

‎domain-specific-terms.txt

+2
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ paket
99
beginn
1010
referenz
1111
alle
12+
ende
13+
tages

‎json_schemas/Anwendungshandbuch.schema.json

+50-40
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,26 @@
11
{
22
"$defs": {
33
"Anwendungsfall": {
4-
"description": "One Anwendungsfall \"AWF\" corresponds to one Prüfidentifikator or Type of Message",
4+
"description": "One 'Anwendungsfall', indicated by `<AWF>` tag, corresponds to one Prüfidentifikator or type of Message",
55
"properties": {
66
"beschreibung": {
77
"title": "Beschreibung",
88
"type": "string"
99
},
10+
"elements": {
11+
"items": {
12+
"anyOf": [
13+
{
14+
"$ref": "#/$defs/Segment"
15+
},
16+
{
17+
"$ref": "#/$defs/SegmentGroup"
18+
}
19+
]
20+
},
21+
"title": "Elements",
22+
"type": "array"
23+
},
1024
"format": {
1125
"title": "Format",
1226
"type": "string"
@@ -18,29 +32,14 @@
1832
"pruefidentifikator": {
1933
"title": "Pruefidentifikator",
2034
"type": "string"
21-
},
22-
"segment_groups": {
23-
"items": {
24-
"$ref": "#/$defs/SegmentGroup"
25-
},
26-
"title": "Segment Groups",
27-
"type": "array"
28-
},
29-
"segments": {
30-
"items": {
31-
"$ref": "#/$defs/Segment"
32-
},
33-
"title": "Segments",
34-
"type": "array"
3535
}
3636
},
3737
"required": [
3838
"pruefidentifikator",
3939
"beschreibung",
4040
"kommunikation_von",
4141
"format",
42-
"segments",
43-
"segment_groups"
42+
"elements"
4443
],
4544
"title": "Anwendungsfall",
4645
"type": "object"
@@ -65,7 +64,7 @@
6564
"type": "object"
6665
},
6766
"Code": {
68-
"description": "a single code element inside an AHB DataElement",
67+
"description": "A single code element inside an AHB DataElement, indicated by the `<Code>` tag.",
6968
"properties": {
7069
"ahb_status": {
7170
"title": "Ahb Status",
@@ -108,8 +107,19 @@
108107
"type": "object"
109108
},
110109
"DataElement": {
111-
"description": "A single data element inside a AHB Segment.\nThis models both the 'Datenelement' and the 'Gruppendatenelement'",
110+
"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.",
112111
"properties": {
112+
"ahb_status": {
113+
"anyOf": [
114+
{
115+
"type": "string"
116+
},
117+
{
118+
"type": "null"
119+
}
120+
],
121+
"title": "Ahb Status"
122+
},
113123
"codes": {
114124
"items": {
115125
"$ref": "#/$defs/Code"
@@ -129,13 +139,14 @@
129139
"required": [
130140
"id",
131141
"name",
142+
"ahb_status",
132143
"codes"
133144
],
134145
"title": "DataElement",
135146
"type": "object"
136147
},
137148
"DataElementGroup": {
138-
"description": "a group of data elements, German 'Datenelementgruppe' inside the AHB",
149+
"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'",
139150
"properties": {
140151
"data_elements": {
141152
"items": {
@@ -181,7 +192,7 @@
181192
"type": "object"
182193
},
183194
"Segment": {
184-
"description": "a segment inside an AHB",
195+
"description": "A segment inside an AHB, indicated by the `<S_xxxx>` tag.\nThis model can contain both data elements and data element groups.",
185196
"properties": {
186197
"ahb_status": {
187198
"anyOf": [
@@ -232,7 +243,7 @@
232243
"type": "object"
233244
},
234245
"SegmentGroup": {
235-
"description": "a \"Segmentgruppe\" inside an AHB",
246+
"description": "A 'Segmentgruppe' inside an AHB, indicated by the `<G_xxxx>` tag.\nThis model can contain both Segments and segment groups.",
236247
"properties": {
237248
"ahb_status": {
238249
"anyOf": [
@@ -245,35 +256,34 @@
245256
],
246257
"title": "Ahb Status"
247258
},
259+
"elements": {
260+
"items": {
261+
"anyOf": [
262+
{
263+
"$ref": "#/$defs/Segment"
264+
},
265+
{
266+
"$ref": "#/$defs/SegmentGroup"
267+
}
268+
]
269+
},
270+
"title": "Elements",
271+
"type": "array"
272+
},
248273
"id": {
249274
"title": "Id",
250275
"type": "string"
251276
},
252277
"name": {
253278
"title": "Name",
254279
"type": "string"
255-
},
256-
"segment_groups": {
257-
"items": {
258-
"$ref": "#/$defs/SegmentGroup"
259-
},
260-
"title": "Segment Groups",
261-
"type": "array"
262-
},
263-
"segments": {
264-
"items": {
265-
"$ref": "#/$defs/Segment"
266-
},
267-
"title": "Segments",
268-
"type": "array"
269280
}
270281
},
271282
"required": [
272283
"id",
273284
"name",
274285
"ahb_status",
275-
"segments",
276-
"segment_groups"
286+
"elements"
277287
],
278288
"title": "SegmentGroup",
279289
"type": "object"
@@ -298,7 +308,7 @@
298308
"type": "object"
299309
}
300310
},
301-
"description": "Ein Anwendungshandbuch bündelt verschiedene Nachrichtentypen/Anwendungsfälle im selben Format oder mit der selben\nregulatorischen Grundlage und stellt gemeinsame Pakete & Bedingungen bereit.",
311+
"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.",
302312
"properties": {
303313
"anwendungsfaelle": {
304314
"items": {
@@ -353,4 +363,4 @@
353363
],
354364
"title": "Anwendungshandbuch",
355365
"type": "object"
356-
}
366+
}

‎json_schemas/MessageImplementationGuide.schema.json

+37-38
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$defs": {
33
"Code": {
4-
"description": "a single code element inside a MIG Dataelement",
4+
"description": "A single code element inside a MIG data element, indicated by the `<Code>` tag.",
55
"properties": {
66
"description": {
77
"anyOf": [
@@ -39,7 +39,7 @@
3939
"type": "object"
4040
},
4141
"DataElement": {
42-
"description": "A single data element inside a MIG Segment.\nThis models both the 'Datenelement' and the 'Gruppendatenelement'",
42+
"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.",
4343
"properties": {
4444
"codes": {
4545
"items": {
@@ -96,7 +96,7 @@
9696
"type": "object"
9797
},
9898
"DataElementGroup": {
99-
"description": "a group of data elements, German 'Datenelementgruppe'.",
99+
"description": "A group of data elements, German 'Datenelementgruppe', indicated by the `<C_xxxx>` tag.\nAre able to contain a single or multiple data elements.",
100100
"properties": {
101101
"data_elements": {
102102
"items": {
@@ -149,13 +149,14 @@
149149
"C",
150150
"R",
151151
"N",
152-
"D"
152+
"D",
153+
"O"
153154
],
154155
"title": "MigStatus",
155156
"type": "string"
156157
},
157158
"Segment": {
158-
"description": "a segment inside a MIG",
159+
"description": "A segment inside a MIG, indicated by the `<S_xxxx>` tag. A segment contains data elements and data element groups.",
159160
"properties": {
160161
"counter": {
161162
"title": "Counter",
@@ -246,12 +247,26 @@
246247
"type": "object"
247248
},
248249
"SegmentGroup": {
249-
"description": "a \"Segtmentgruppe\"",
250+
"description": "A 'Segmentgruppe' inside a MIG, indicated by the `<G_xxx>` tag. A segment contains segments and segments groups.",
250251
"properties": {
251252
"counter": {
252253
"title": "Counter",
253254
"type": "string"
254255
},
256+
"elements": {
257+
"items": {
258+
"anyOf": [
259+
{
260+
"$ref": "#/$defs/Segment"
261+
},
262+
{
263+
"$ref": "#/$defs/SegmentGroup"
264+
}
265+
]
266+
},
267+
"title": "Elements",
268+
"type": "array"
269+
},
255270
"id": {
256271
"title": "Id",
257272
"type": "string"
@@ -272,20 +287,6 @@
272287
"title": "Name",
273288
"type": "string"
274289
},
275-
"segment_groups": {
276-
"items": {
277-
"$ref": "#/$defs/SegmentGroup"
278-
},
279-
"title": "Segment Groups",
280-
"type": "array"
281-
},
282-
"segments": {
283-
"items": {
284-
"$ref": "#/$defs/Segment"
285-
},
286-
"title": "Segments",
287-
"type": "array"
288-
},
289290
"status_specification": {
290291
"$ref": "#/$defs/MigStatus"
291292
},
@@ -302,8 +303,7 @@
302303
"max_rep_specification",
303304
"status_std",
304305
"status_specification",
305-
"segments",
306-
"segment_groups"
306+
"elements"
307307
],
308308
"title": "SegmentGroup",
309309
"type": "object"
@@ -315,23 +315,23 @@
315315
"title": "Autor",
316316
"type": "string"
317317
},
318-
"format": {
319-
"title": "Format",
320-
"type": "string"
321-
},
322-
"segment_groups": {
318+
"elements": {
323319
"items": {
324-
"$ref": "#/$defs/SegmentGroup"
320+
"anyOf": [
321+
{
322+
"$ref": "#/$defs/Segment"
323+
},
324+
{
325+
"$ref": "#/$defs/SegmentGroup"
326+
}
327+
]
325328
},
326-
"title": "Segment Groups",
329+
"title": "Elements",
327330
"type": "array"
328331
},
329-
"segments": {
330-
"items": {
331-
"$ref": "#/$defs/Segment"
332-
},
333-
"title": "Segments",
334-
"type": "array"
332+
"format": {
333+
"title": "Format",
334+
"type": "string"
335335
},
336336
"veroeffentlichungsdatum": {
337337
"format": "date",
@@ -348,9 +348,8 @@
348348
"autor",
349349
"versionsnummer",
350350
"format",
351-
"segments",
352-
"segment_groups"
351+
"elements"
353352
],
354353
"title": "MessageImplementationGuide",
355354
"type": "object"
356-
}
355+
}

0 commit comments

Comments
 (0)