Skip to content

Commit ed34498

Browse files
hoijuihoijui
committed
schema: Pretty-print (no other changes)
1 parent 52129ec commit ed34498

File tree

1 file changed

+114
-26
lines changed

1 file changed

+114
-26
lines changed

‎src/schema/okh.schema.json‎

Lines changed: 114 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,23 @@
1717
"auxiliary": {
1818
"$ref": "#/$defs/relPathOrWebUrlMulti",
1919
"description": "relative or absolute path to files that are neither source files nor their exports, but still useful in the repository (e.g. KiCAD library files);\\\nmultiple inputs possible (with one entry each)",
20-
"examples": ["lib/lib1.lib", ".mdlrc", ["lib/lib1.lib", ".mdlrc"]]
20+
"examples": [
21+
"lib/lib1.lib",
22+
".mdlrc",
23+
[
24+
"lib/lib1.lib",
25+
".mdlrc"
26+
]
27+
]
2128
},
2229
"bom": {
2330
"$ref": "#/$defs/relPathOrWebUrlMulti",
2431
"description": "URL or repo-relative path to the bill of materials",
25-
"examples": ["sBoM.csv", "BOM.csv", "bom.csv"]
32+
"examples": [
33+
"sBoM.csv",
34+
"BOM.csv",
35+
"bom.csv"
36+
]
2637
},
2738
"cpcId": {
2839
"$comment": "Get a CPC-ID from here <https://worldwide.espacenet.com/classification>",
@@ -57,7 +68,10 @@
5768
"H02J 1/1234",
5869
"H02J 1/12345",
5970
"H02J 1/123456",
60-
["D03D 35/00", "D03D 5/00"]
71+
[
72+
"D03D 35/00",
73+
"D03D 5/00"
74+
]
6175
],
6276
"anyOf": [
6377
{
@@ -74,7 +88,11 @@
7488
]
7589
},
7690
"date": {
77-
"examples": ["2000-04-06", "0001-0-0", "1984-10-1"],
91+
"examples": [
92+
"2000-04-06",
93+
"0001-0-0",
94+
"1984-10-1"
95+
],
7896
"type": "string",
7997
"format": "date"
8098
},
@@ -126,14 +144,20 @@
126144
"examples": [
127145
"3D-parts/assembly.stp",
128146
"public/user-manual.pdf",
129-
["3D-parts/assembly.stp", "public/user-manual.pdf"]
147+
[
148+
"3D-parts/assembly.stp",
149+
"public/user-manual.pdf"
150+
]
130151
]
131152
},
132153
"lang-text": {
133154
"description": "a text and the language it is written in",
134155
"type": "object",
135156
"additionalProperties": false,
136-
"required": ["text", "language"],
157+
"required": [
158+
"text",
159+
"language"
160+
],
137161
"properties": {
138162
"text": {
139163
"description": "the text content",
@@ -211,7 +235,9 @@
211235
]
212236
}
213237
],
214-
"required": ["location"],
238+
"required": [
239+
"location"
240+
],
215241
"properties": {
216242
"location": {
217243
"$ref": "#/$defs/relPathOrWebUrl",
@@ -301,7 +327,12 @@
301327
"language": {
302328
"$comment": "autocomplete",
303329
"description": "Language as a BCP 47 language tag",
304-
"examples": ["en", "de", "es", "zh"],
330+
"examples": [
331+
"en",
332+
"de",
333+
"es",
334+
"zh"
335+
],
305336
"type": "string",
306337
"pattern": "^(((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+))$"
307338
},
@@ -353,7 +384,10 @@
353384
"Open Source Hardware Association",
354385
"Open Source Ecology",
355386
"Open Source Ecology Germany",
356-
["Free Software Foundation", "Open Source Initiative"],
387+
[
388+
"Free Software Foundation",
389+
"Open Source Initiative"
390+
],
357391
{
358392
"name": "Free Software Foundation",
359393
"url": "https://www.fsf.org"
@@ -388,7 +422,11 @@
388422
"description": "Outer dimensions of the OSH module or part in mm (millimeters), which completely encompass the product.",
389423
"type": "object",
390424
"additionalProperties": false,
391-
"required": ["width", "depth", "height"],
425+
"required": [
426+
"width",
427+
"depth",
428+
"height"
429+
],
392430
"properties": {
393431
"depth": {
394432
"type": "number",
@@ -408,16 +446,22 @@
408446
"description": "a physical component of an open source hardware module, for which technical documentation (design files etc.) is available under a free/open license",
409447
"type": "object",
410448
"additionalProperties": false,
411-
"required": ["name"],
449+
"required": [
450+
"name"
451+
],
412452
"oneOf": [
413453
{
414-
"required": ["source"],
454+
"required": [
455+
"source"
456+
],
415457
"properties": {
416458
"source": {}
417459
}
418460
},
419461
{
420-
"required": ["export"],
462+
"required": [
463+
"export"
464+
],
421465
"properties": {
422466
"export": {}
423467
}
@@ -471,7 +515,9 @@
471515
"rdfNamespace": {
472516
"type": "object",
473517
"additionalProperties": false,
474-
"required": ["namespace"],
518+
"required": [
519+
"namespace"
520+
],
475521
"properties": {
476522
"namespace": {
477523
"type": "string",
@@ -482,7 +528,11 @@
482528
},
483529
"prefix": {
484530
"type": "string",
485-
"examples": ["prjx", "myorg-prjx", "mycomp-prjx"]
531+
"examples": [
532+
"prjx",
533+
"myorg-prjx",
534+
"mycomp-prjx"
535+
]
486536
}
487537
}
488538
},
@@ -533,7 +583,9 @@
533583
"software": {
534584
"type": "object",
535585
"additionalProperties": false,
536-
"required": ["release"],
586+
"required": [
587+
"release"
588+
],
537589
"properties": {
538590
"installation-guide": {
539591
"$ref": "#/$defs/relPathOrWebUrl",
@@ -559,7 +611,10 @@
559611
"pcb/main.pro",
560612
"pcb/main.kicad_pcb",
561613
"cad/part-x/model.fcstd",
562-
["pcb/main.kicad_pcb", "cad/part-x/model.fcstd"]
614+
[
615+
"pcb/main.kicad_pcb",
616+
"cad/part-x/model.fcstd"
617+
]
563618
]
564619
},
565620
"spdxLicenseExpression": {
@@ -593,7 +648,11 @@
593648
"3DP",
594649
"LAS",
595650
"CNC",
596-
["ASM", "MEC", "CIR"]
651+
[
652+
"ASM",
653+
"MEC",
654+
"CIR"
655+
]
597656
]
598657
},
599658
"webUrl": {
@@ -623,7 +682,9 @@
623682
"allOf": [
624683
{
625684
"if": {
626-
"required": ["tsdc"],
685+
"required": [
686+
"tsdc"
687+
],
627688
"properties": {
628689
"tsdc": {
629690
"type": "array",
@@ -639,14 +700,22 @@
639700
"type": "string"
640701
},
641702
"printing-process": {
642-
"enum": ["FDM", "SLA", "SLS", "MJF", "DMLS"]
703+
"enum": [
704+
"FDM",
705+
"SLA",
706+
"SLS",
707+
"MJF",
708+
"DMLS"
709+
]
643710
}
644711
}
645712
}
646713
},
647714
{
648715
"if": {
649-
"required": ["tsdc"],
716+
"required": [
717+
"tsdc"
718+
],
650719
"properties": {
651720
"tsdc": {
652721
"type": "array",
@@ -673,7 +742,14 @@
673742
}
674743
}
675744
],
676-
"required": ["okhv", "name", "repo", "license", "licensor", "function"],
745+
"required": [
746+
"okhv",
747+
"name",
748+
"repo",
749+
"license",
750+
"licensor",
751+
"function"
752+
],
677753
"properties": {
678754
"$schema": {
679755
"description": "Link to OKH JSON-Schema",
@@ -696,7 +772,12 @@
696772
"contribution-guide": {
697773
"$ref": "#/$defs/relPathOrWebUrl",
698774
"description": "repo-relative path to the contribution guide",
699-
"examples": ["CONTRIBUTING.md", "CONTRIB.md", "CONTRIBUTING", "CONTRIB"]
775+
"examples": [
776+
"CONTRIBUTING.md",
777+
"CONTRIB.md",
778+
"CONTRIBUTING",
779+
"CONTRIB"
780+
]
700781
},
701782
"cpc-patent-class": {
702783
"$ref": "#/$defs/cpcId",
@@ -847,7 +928,9 @@
847928
"manufacturing-instructions": {
848929
"$ref": "#/$defs/relPathOrWebUrlMulti",
849930
"description": "URL or repo-relative path to manufacturing instructions; multiple inputs possible (with one entry each)",
850-
"examples": ["Documentation/Assembly_Guide/AssemblyGuide.md"]
931+
"examples": [
932+
"Documentation/Assembly_Guide/AssemblyGuide.md"
933+
]
851934
},
852935
"mass": {
853936
"$ref": "#/$defs/mass"
@@ -927,7 +1010,10 @@
9271010
"DIN SPEC 3105",
9281011
"DIN EN 1335",
9291012
"ISO 1337",
930-
["DIN SPEC 3105", "ISO 1337"]
1013+
[
1014+
"DIN SPEC 3105",
1015+
"ISO 1337"
1016+
]
9311017
]
9321018
},
9331019
"technology-readiness-level": {
@@ -972,7 +1058,9 @@
9721058
"user-manual": {
9731059
"$ref": "#/$defs/relPathOrWebUrlMulti",
9741060
"description": "URL or repo-relative path to user manual",
975-
"examples": ["Documentation/User_Guide/UserGuide.md"]
1061+
"examples": [
1062+
"Documentation/User_Guide/UserGuide.md"
1063+
]
9761064
},
9771065
"version": {
9781066
"description": "version of this Module, preferably following the [semantic versioning-scheme v2.0.0](https://semver.org/#semantic-versioning-200)",

0 commit comments

Comments
 (0)