Skip to content

Commit 1604d8f

Browse files
authored
allowing for extra properties in edi file declaration (#207)
Adding `_comment` property to EDI schema to annotate segments and/or elements.
1 parent b4d60ad commit 1604d8f

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

extensions/omniv21/samples/edi/1_canadapost_edi_214.schema.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"child_segments": [
1313
{
1414
"name": "GS",
15+
"_comment": "functional group",
1516
"child_segments": [
1617
{
1718
"name": "scanInfo", "type": "segment_group", "min": 0, "max": -1, "is_target": true,
@@ -26,7 +27,7 @@
2627
{
2728
"name": "N4",
2829
"elements": [
29-
{ "name": "cityName", "index": 1 },
30+
{ "name": "cityName", "index": 1, "_comment": "E19" },
3031
{ "name": "provinceCode", "index": 2 },
3132
{ "name": "postalCode", "index": 3 },
3233
{ "name": "countryCode", "index": 4 }

extensions/omniv21/samples/edi/2_ups_edi_210.schema.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
"child_segments": [
1515
{
1616
"name": "GS",
17+
"_comment": "functional group",
1718
"child_segments": [
1819
{
1920
"name": "invoiceInfo", "type": "segment_group", "min": 0, "max": -1, "is_target": true,
@@ -74,7 +75,7 @@
7475
"elements": [
7576
{ "name": "refIdQualifier_N901", "index": 1 },
7677
{ "name": "refId_N902", "index": 2, "default": "" },
77-
{ "name": "date", "index": 4, "default": "" },
78+
{ "name": "date", "index": 4, "default": "", "_comment": "YYYYMMDD"},
7879
{ "name": "product_code_C04004", "index": 7, "component_index": 4, "default": "" }
7980
]
8081
},

extensions/omniv21/validation/ediFileDeclaration.go

+6-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

extensions/omniv21/validation/ediFileDeclaration.json

+6-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@
4242
"index": { "type": "integer", "minimum": 1 },
4343
"component_index": { "type": "integer", "minimum": 1 },
4444
"empty_if_missing": { "type": "boolean","$comment": "deprecated, use 'default'" },
45-
"default": { "type": "string" }
45+
"default": { "type": "string" },
46+
"_comment": { "$ref": "#/definitions/value_comment" }
4647
},
4748
"required": [ "name", "index" ],
4849
"additionalProperties": false
@@ -53,10 +54,12 @@
5354
"items": {
5455
"$ref": "#/definitions/segment_declaration_type"
5556
}
56-
}
57+
},
58+
"_comment": { "$ref": "#/definitions/value_comment" }
5759
},
5860
"required": [ "name" ],
5961
"additionalProperties": false
60-
}
62+
},
63+
"value_comment": { "type": "string" }
6164
}
6265
}

0 commit comments

Comments
 (0)