Skip to content

Commit 69cc59d

Browse files
stevespringettstevespringett
committed
Documentation improvements
Signed-off-by: Steve Springett <steve@springett.us>
1 parent 2003555 commit 69cc59d

1 file changed

Lines changed: 65 additions & 17 deletions

File tree

‎schema/bom-1.5.schema.json‎

Lines changed: 65 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -132,25 +132,31 @@
132132
"allOf": [{"$ref": "#/definitions/refType"}]
133133
},
134134
"bomLinkDocumentType": {
135-
"title": "BOM-Link document",
135+
"title": "BOM-Link Document",
136136
"description": "Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/",
137137
"type": "string",
138138
"format": "iri-reference",
139139
"pattern": "^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$",
140140
"$comment": "part of the pattern is based on `bom.serialNumber`'s pattern"
141141
},
142142
"bomLinkElementType": {
143-
"title": "BOM-Link element",
144-
"description": "Descriptor for an element in another BOM document. See https://cyclonedx.org/capabilities/bomlink/",
143+
"title": "BOM-Link Element",
144+
"description": "Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/",
145145
"type": "string",
146146
"format": "iri-reference",
147147
"pattern": "^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$",
148148
"$comment": "part of the pattern is based on `bom.serialNumber`'s pattern"
149149
},
150150
"bomLink": {
151151
"anyOf": [
152-
{"$ref": "#/definitions/bomLinkDocumentType"},
153-
{"$ref": "#/definitions/bomLinkElementType"}
152+
{
153+
"title": "BOM-Link Document",
154+
"$ref": "#/definitions/bomLinkDocumentType"
155+
},
156+
{
157+
"title": "BOM-Link Element",
158+
"$ref": "#/definitions/bomLinkElementType"
159+
}
154160
]
155161
},
156162
"metadata": {
@@ -1136,10 +1142,12 @@
11361142
"url": {
11371143
"anyOf": [
11381144
{
1145+
"title": "URL",
11391146
"type": "string",
11401147
"format": "iri-reference"
11411148
},
11421149
{
1150+
"title": "BOM-Link",
11431151
"$ref": "#/definitions/bomLink"
11441152
}
11451153
],
@@ -1380,10 +1388,12 @@
13801388
"items": {
13811389
"anyOf": [
13821390
{
1391+
"title": "URL",
13831392
"type": "string",
13841393
"format": "iri-reference"
13851394
},
13861395
{
1396+
"title": "BOM-Link Element",
13871397
"$ref": "#/definitions/bomLinkElementType"
13881398
}
13891399
]
@@ -1396,10 +1406,12 @@
13961406
"items": {
13971407
"anyOf": [
13981408
{
1409+
"title": "URL",
13991410
"type": "string",
14001411
"format": "iri-reference"
14011412
},
14021413
{
1414+
"title": "BOM-Link Element",
14031415
"$ref": "#/definitions/bomLinkElementType"
14041416
}
14051417
]
@@ -1511,8 +1523,14 @@
15111523
"uniqueItems": true,
15121524
"items": {
15131525
"anyOf": [
1514-
{"$ref": "#/definitions/refLinkType"},
1515-
{"$ref": "#/definitions/bomLinkElementType"}
1526+
{
1527+
"title": "Ref",
1528+
"$ref": "#/definitions/refLinkType"
1529+
},
1530+
{
1531+
"title": "BOM-Link Element",
1532+
"$ref": "#/definitions/bomLinkElementType"
1533+
}
15161534
]
15171535
},
15181536
"title": "BOM References",
@@ -1634,8 +1652,14 @@
16341652
"uniqueItems": true,
16351653
"items": {
16361654
"anyOf": [
1637-
{"$ref": "#/definitions/refLinkType"},
1638-
{"$ref": "#/definitions/bomLinkElementType"}
1655+
{
1656+
"title": "Ref",
1657+
"$ref": "#/definitions/refLinkType"
1658+
},
1659+
{
1660+
"title": "BOM-Link Element",
1661+
"$ref": "#/definitions/bomLinkElementType"
1662+
}
16391663
]
16401664
},
16411665
"title": "BOM references",
@@ -2219,8 +2243,14 @@
22192243
"properties": {
22202244
"ref": {
22212245
"anyOf": [
2222-
{"$ref": "#/definitions/refLinkType"},
2223-
{"$ref": "#/definitions/bomLinkElementType"}
2246+
{
2247+
"title": "Ref",
2248+
"$ref": "#/definitions/refLinkType"
2249+
},
2250+
{
2251+
"title": "BOM-Link Element",
2252+
"$ref": "#/definitions/bomLinkElementType"
2253+
}
22242254
],
22252255
"title": "Reference",
22262256
"description": "References a component or service by the objects bom-ref"
@@ -2315,8 +2345,14 @@
23152345
"uniqueItems": true,
23162346
"items": {
23172347
"anyOf": [
2318-
{"$ref": "#/definitions/refLinkType"},
2319-
{"$ref": "#/definitions/bomLinkElementType"}
2348+
{
2349+
"title": "Ref",
2350+
"$ref": "#/definitions/refLinkType"
2351+
},
2352+
{
2353+
"title": "BOM-Link Element",
2354+
"$ref": "#/definitions/bomLinkElementType"
2355+
}
23202356
]
23212357
},
23222358
"title": "BOM References",
@@ -2456,8 +2492,14 @@
24562492
"properties": {
24572493
"ref": {
24582494
"anyOf": [
2459-
{"$ref": "#/definitions/refLinkType"},
2460-
{"$ref": "#/definitions/bomLinkElementType"}
2495+
{
2496+
"title": "Ref",
2497+
"$ref": "#/definitions/refLinkType"
2498+
},
2499+
{
2500+
"title": "BOM-Link Element",
2501+
"$ref": "#/definitions/bomLinkElementType"
2502+
}
24612503
],
24622504
"title": "Reference",
24632505
"description": "References a data component by the components bom-ref attribute"
@@ -3646,8 +3688,14 @@
36463688
"title": "BOM Reference",
36473689
"description": "References an object by its bom-ref attribute",
36483690
"anyOf": [
3649-
{"$ref": "#/definitions/refLinkType"},
3650-
{"$ref": "#/definitions/bomLinkElementType"}
3691+
{
3692+
"title": "Ref",
3693+
"$ref": "#/definitions/refLinkType"
3694+
},
3695+
{
3696+
"title": "BOM-Link Element",
3697+
"$ref": "#/definitions/bomLinkElementType"
3698+
}
36513699
]
36523700
},
36533701
"externalReference": {

0 commit comments

Comments
 (0)