Skip to content

Commit 03bf599

Browse files
Added missing titles and descriptions
Signed-off-by: Steve Springett <[email protected]>
1 parent 11d71cb commit 03bf599

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

schema/bom-1.7.schema.json

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -551,12 +551,14 @@
551551
},
552552
"definitions": {
553553
"refType": {
554+
"title": "BOM Reference",
554555
"description": "Identifier for referable and therefore interlinkable elements.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
555556
"type": "string",
556557
"minLength": 1,
557558
"$comment": "TODO (breaking change): add a format constraint that prevents the value from staring with 'urn:cdx:'"
558559
},
559560
"refLinkType": {
561+
"title": "BOM Reference",
560562
"description": "Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.\nIn contrast to `bomLinkElementType`.",
561563
"$ref": "#/definitions/refType"
562564
},
@@ -845,6 +847,7 @@
845847
"organizationalContact": {
846848
"type": "object",
847849
"additionalProperties": false,
850+
"title": "Organizational Person",
848851
"properties": {
849852
"bom-ref": {
850853
"$ref": "#/definitions/refType",
@@ -2474,6 +2477,7 @@
24742477
"required": [
24752478
"name"
24762479
],
2480+
"additionalProperties": false,
24772481
"properties": {
24782482
"name": {
24792483
"type": "string",
@@ -2485,8 +2489,7 @@
24852489
"title": "Value",
24862490
"description": "The value of the property."
24872491
}
2488-
},
2489-
"additionalProperties": false
2492+
}
24902493
},
24912494
"localeType": {
24922495
"type": "string",
@@ -4728,7 +4731,9 @@
47284731
"$ref": "#/definitions/property"
47294732
},
47304733
{
4731-
"type": "string"
4734+
"type": "string",
4735+
"title": "String-Based Environment Variables",
4736+
"description": "In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning."
47324737
}
47334738
]
47344739
}
@@ -4818,7 +4823,9 @@
48184823
"$ref": "#/definitions/property"
48194824
},
48204825
{
4821-
"type": "string"
4826+
"type": "string",
4827+
"title": "String-Based Environment Variables",
4828+
"description": "In addition to the more common key–value pair format, some environment variables may consist of a single string without an explicit value assignment. These string-based environment variables typically act as flags or signals to software, indicating that a feature should be enabled, a mode should be activated, or a specific condition is present. Their presence alone conveys meaning."
48224829
}
48234830
]
48244831
},
@@ -5973,6 +5980,7 @@
59735980
"anyOf": [
59745981
{
59755982
"type": "array",
5983+
"title": "Encryption Algorithms (ENCR)",
59765984
"items": {
59775985
"$ref": "#/definitions/ikeV2Enc",
59785986
"title": "Encryption Algorithm (ENCR)"
@@ -5981,6 +5989,7 @@
59815989
{
59825990
"deprecated": true,
59835991
"$ref": "#/definitions/cryptoRefArray",
5992+
"title": "Encryption Algorithm (ENCR) References",
59845993
"description": "[DEPRECATED] This will be removed in a future version.\nTransform Type 1: encryption algorithms"
59855994
}
59865995
]
@@ -5991,6 +6000,7 @@
59916000
"anyOf": [
59926001
{
59936002
"type": "array",
6003+
"title": "Pseudorandom Functions (PRF)",
59946004
"items": {
59956005
"$ref": "#/definitions/ikeV2Prf",
59966006
"title": "Pseudorandom Function (PRF)"
@@ -6009,6 +6019,7 @@
60096019
"anyOf": [
60106020
{
60116021
"type": "array",
6022+
"title": "Integrity Algorithms (INTEG)",
60126023
"items": {
60136024
"$ref": "#/definitions/ikeV2Integ",
60146025
"title": "Integrity Algorithm (INTEG)"
@@ -6027,6 +6038,7 @@
60276038
"anyOf": [
60286039
{
60296040
"type": "array",
6041+
"title": "Key Exchange Methods (KE)",
60306042
"items": {
60316043
"$ref": "#/definitions/ikeV2Ke",
60326044
"title": "Key Exchange Method (KE)"
@@ -6050,6 +6062,7 @@
60506062
"anyOf": [
60516063
{
60526064
"type": "array",
6065+
"title": "IKEv2 Authentication Methods",
60536066
"items": {
60546067
"$ref": "#/definitions/ikeV2Auth",
60556068
"title": "IKEv2 Authentication Method"
@@ -6259,6 +6272,7 @@
62596272
},
62606273
"cryptoRefArray" : {
62616274
"deprecated": true,
6275+
"title": "Encryption Algorithm (ENCR) Reference Array",
62626276
"description": "Deprecated definition.",
62636277
"type": "array",
62646278
"items": {
@@ -6553,10 +6567,12 @@
65536567
"asserter": {
65546568
"oneOf": [
65556569
{
6556-
"$ref": "#/definitions/organizationalEntity"
6570+
"$ref": "#/definitions/organizationalEntity",
6571+
"title": "Organizational Entity"
65576572
},
65586573
{
6559-
"$ref": "#/definitions/organizationalContact"
6574+
"$ref": "#/definitions/organizationalContact",
6575+
"title": "Person"
65606576
},
65616577
{
65626578
"$ref": "#/definitions/refLinkType",

0 commit comments

Comments
 (0)