@cyclonedx/cdxgen 11.3.2 → 11.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,7 +13,7 @@
13
13
  "bomFormat": {
14
14
  "type": "string",
15
15
  "title": "BOM Format",
16
- "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention, nor does JSON schema support namespaces. This value MUST be \"CycloneDX\".",
16
+ "description": "Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention, nor does JSON schema support namespaces. This value must be \"CycloneDX\".",
17
17
  "enum": ["CycloneDX"]
18
18
  },
19
19
  "specVersion": {
@@ -25,7 +25,7 @@
25
25
  "serialNumber": {
26
26
  "type": "string",
27
27
  "title": "BOM Serial Number",
28
- "description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number MUST conform to RFC-4122. Use of serial numbers is RECOMMENDED.",
28
+ "description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number must conform to [RFC 4122](https://www.ietf.org/rfc/rfc4122.html). Use of serial numbers is recommended.",
29
29
  "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
30
30
  "pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
31
31
  },
@@ -116,7 +116,7 @@
116
116
  "bom-ref": {
117
117
  "$ref": "#/definitions/refType",
118
118
  "title": "BOM Reference",
119
- "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
119
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
120
120
  },
121
121
  "thirdParty": {
122
122
  "type": "boolean",
@@ -245,7 +245,7 @@
245
245
  "bom-ref": {
246
246
  "$ref": "#/definitions/refType",
247
247
  "title": "BOM Reference",
248
- "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
248
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
249
249
  },
250
250
  "target": {
251
251
  "$ref": "#/definitions/refLinkType",
@@ -306,7 +306,7 @@
306
306
  "bom-ref": {
307
307
  "$ref": "#/definitions/refType",
308
308
  "title": "BOM Reference",
309
- "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
309
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
310
310
  },
311
311
  "propertyName": {
312
312
  "type": "string",
@@ -428,6 +428,7 @@
428
428
  "affirmation": {
429
429
  "type": "object",
430
430
  "title": "Affirmation",
431
+ "description": "A concise statement affirmed by an individual regarding all declarations, often used for third-party auditor acceptance or recipient acknowledgment. It includes a list of authorized signatories who assert the validity of the document on behalf of the organization.",
431
432
  "additionalProperties": false,
432
433
  "properties": {
433
434
  "statement": {
@@ -516,7 +517,7 @@
516
517
  "properties": {
517
518
  "type": "array",
518
519
  "title": "Properties",
519
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
520
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
520
521
  "items": {
521
522
  "$ref": "#/definitions/property"
522
523
  }
@@ -706,7 +707,7 @@
706
707
  "properties": {
707
708
  "type": "array",
708
709
  "title": "Properties",
709
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
710
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
710
711
  "items": { "$ref": "#/definitions/property" }
711
712
  }
712
713
  }
@@ -749,13 +750,12 @@
749
750
  "organizationalEntity": {
750
751
  "type": "object",
751
752
  "title": "Organizational Entity",
752
- "description": "",
753
753
  "additionalProperties": false,
754
754
  "properties": {
755
755
  "bom-ref": {
756
756
  "$ref": "#/definitions/refType",
757
757
  "title": "BOM Reference",
758
- "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
758
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
759
759
  },
760
760
  "name": {
761
761
  "type": "string",
@@ -789,13 +789,12 @@
789
789
  "organizationalContact": {
790
790
  "type": "object",
791
791
  "title": "Organizational Contact",
792
- "description": "",
793
792
  "additionalProperties": false,
794
793
  "properties": {
795
794
  "bom-ref": {
796
795
  "$ref": "#/definitions/refType",
797
796
  "title": "BOM Reference",
798
- "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
797
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
799
798
  },
800
799
  "name": {
801
800
  "type": "string",
@@ -844,7 +843,7 @@
844
843
  "meta:enum": {
845
844
  "application": "A software application. Refer to [https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software) for information about applications.",
846
845
  "framework": "A software framework. Refer to [https://en.wikipedia.org/wiki/Software_framework](https://en.wikipedia.org/wiki/Software_framework) for information on how frameworks vary slightly from libraries.",
847
- "library": "A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing)) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is RECOMMENDED.",
846
+ "library": "A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing)) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is recommended.",
848
847
  "container": "A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization).",
849
848
  "platform": "A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms.",
850
849
  "operating-system": "A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system).",
@@ -870,7 +869,7 @@
870
869
  "bom-ref": {
871
870
  "$ref": "#/definitions/refType",
872
871
  "title": "BOM Reference",
873
- "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
872
+ "description": "An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
874
873
  },
875
874
  "supplier": {
876
875
  "title": "Component Supplier",
@@ -960,7 +959,7 @@
960
959
  "purl": {
961
960
  "type": "string",
962
961
  "title": "Package URL (purl)",
963
- "description": "Asserts the identity of the component using package-url (purl). The purl, if specified, MUST be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
962
+ "description": "Asserts the identity of the component using package-url (purl). The purl, if specified, must be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
964
963
  "examples": [
965
964
  "pkg:maven/com.acme/tomcat-catalina@9.0.14?packaging=jar"
966
965
  ]
@@ -968,7 +967,7 @@
968
967
  "omniborId": {
969
968
  "type": "array",
970
969
  "title": "OmniBOR Artifact Identifier (gitoid)",
971
- "description": "Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, MUST be valid and conform to the specification defined at: [https://www.iana.org/assignments/uri-schemes/prov/gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
970
+ "description": "Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: [https://www.iana.org/assignments/uri-schemes/prov/gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
972
971
  "items": { "type": "string" },
973
972
  "examples": [
974
973
  "gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
@@ -977,8 +976,8 @@
977
976
  },
978
977
  "swhid": {
979
978
  "type": "array",
980
- "title": "SoftWare Heritage Identifier",
981
- "description": "Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, MUST be valid and conform to the specification defined at: [https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html](https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
979
+ "title": "Software Heritage Identifier",
980
+ "description": "Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: [https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html](https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.",
982
981
  "items": { "type": "string" },
983
982
  "examples": ["swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"]
984
983
  },
@@ -1066,7 +1065,7 @@
1066
1065
  "type": "array",
1067
1066
  "items": { "$ref": "#/definitions/componentData" },
1068
1067
  "title": "Data",
1069
- "description": "This object SHOULD be specified for any component of type `data` and MUST NOT be specified for other component types."
1068
+ "description": "This object SHOULD be specified for any component of type `data` and must not be specified for other component types."
1070
1069
  },
1071
1070
  "cryptoProperties": {
1072
1071
  "$ref": "#/definitions/cryptoProperties",
@@ -1075,7 +1074,7 @@
1075
1074
  "properties": {
1076
1075
  "type": "array",
1077
1076
  "title": "Properties",
1078
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
1077
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
1079
1078
  "items": { "$ref": "#/definitions/property" }
1080
1079
  },
1081
1080
  "tags": {
@@ -1147,8 +1146,9 @@
1147
1146
  "contentType": {
1148
1147
  "type": "string",
1149
1148
  "title": "Content-Type",
1150
- "description": "Specifies the content type of the text. Defaults to text/plain if not specified.",
1151
- "default": "text/plain"
1149
+ "description": "Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include `application/json` for JSON data and `text/plain` for plan text documents.\n [RFC 2045 section 5.1](https://www.ietf.org/rfc/rfc2045.html#section-5.1) outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the [IANA media types registry](https://www.iana.org/assignments/media-types/media-types.xhtml).",
1150
+ "default": "text/plain",
1151
+ "examples": ["text/plain", "application/json", "image/png"]
1152
1152
  },
1153
1153
  "encoding": {
1154
1154
  "type": "string",
@@ -1209,6 +1209,7 @@
1209
1209
  "license": {
1210
1210
  "type": "object",
1211
1211
  "title": "License",
1212
+ "description": "Specifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.",
1212
1213
  "oneOf": [
1213
1214
  {
1214
1215
  "required": ["id"]
@@ -1222,18 +1223,18 @@
1222
1223
  "bom-ref": {
1223
1224
  "$ref": "#/definitions/refType",
1224
1225
  "title": "BOM Reference",
1225
- "description": "An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
1226
+ "description": "An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
1226
1227
  },
1227
1228
  "id": {
1228
1229
  "$ref": "spdx.schema.json",
1229
1230
  "title": "License ID (SPDX)",
1230
- "description": "A valid SPDX license ID",
1231
+ "description": "A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.",
1231
1232
  "examples": ["Apache-2.0"]
1232
1233
  },
1233
1234
  "name": {
1234
1235
  "type": "string",
1235
1236
  "title": "License Name",
1236
- "description": "If SPDX does not define the license used, this field may be used to provide the license name",
1237
+ "description": "The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.",
1237
1238
  "examples": ["Acme Software License"]
1238
1239
  },
1239
1240
  "acknowledgement": {
@@ -1409,7 +1410,7 @@
1409
1410
  "properties": {
1410
1411
  "type": "array",
1411
1412
  "title": "Properties",
1412
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
1413
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
1413
1414
  "items": { "$ref": "#/definitions/property" }
1414
1415
  }
1415
1416
  }
@@ -1471,7 +1472,7 @@
1471
1472
  "bom-ref": {
1472
1473
  "$ref": "#/definitions/refType",
1473
1474
  "title": "BOM Reference",
1474
- "description": "An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
1475
+ "description": "An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
1475
1476
  }
1476
1477
  }
1477
1478
  }
@@ -1769,10 +1770,10 @@
1769
1770
  "certification-report": "Industry, regulatory, or other certification from an accredited (if applicable) certification body.",
1770
1771
  "codified-infrastructure": "Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC).",
1771
1772
  "quality-metrics": "Report or system in which quality metrics can be obtained.",
1772
- "poam": "Plans of Action and Milestones (POAM) complement an \"attestation\" external reference. POAM is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".",
1773
+ "poam": "Plans of Action and Milestones (POA&M) complement an \"attestation\" external reference. POA&M is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".",
1773
1774
  "electronic-signature": "An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name.",
1774
1775
  "digital-signature": "A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.",
1775
- "rfc-9116": "Document that complies with RFC-9116 (A File Format to Aid in Security Vulnerability Disclosure)",
1776
+ "rfc-9116": "Document that complies with [RFC 9116](https://www.ietf.org/rfc/rfc9116.html) (A File Format to Aid in Security Vulnerability Disclosure)",
1776
1777
  "other": "Use this if no other types accurately describe the purpose of the external reference."
1777
1778
  }
1778
1779
  },
@@ -1787,7 +1788,7 @@
1787
1788
  "dependency": {
1788
1789
  "type": "object",
1789
1790
  "title": "Dependency",
1790
- "description": "Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies MUST be declared as empty elements within the graph. Components or services that are not represented in the dependency graph MAY have unknown dependencies. It is RECOMMENDED that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is RECOMMENDED to leverage compositions to indicate unknown dependency graphs.",
1791
+ "description": "Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies must be declared as empty elements within the graph. Components or services that are not represented in the dependency graph may have unknown dependencies. It is recommended that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is recommended to leverage compositions to indicate unknown dependency graphs.",
1791
1792
  "required": ["ref"],
1792
1793
  "additionalProperties": false,
1793
1794
  "properties": {
@@ -1825,7 +1826,7 @@
1825
1826
  "bom-ref": {
1826
1827
  "$ref": "#/definitions/refType",
1827
1828
  "title": "BOM Reference",
1828
- "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
1829
+ "description": "An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
1829
1830
  },
1830
1831
  "provider": {
1831
1832
  "title": "Provider",
@@ -1887,7 +1888,7 @@
1887
1888
  },
1888
1889
  "licenses": {
1889
1890
  "$ref": "#/definitions/licenseChoice",
1890
- "title": "Component License(s)"
1891
+ "title": "Service License(s)"
1891
1892
  },
1892
1893
  "externalReferences": {
1893
1894
  "type": "array",
@@ -1910,7 +1911,7 @@
1910
1911
  "properties": {
1911
1912
  "type": "array",
1912
1913
  "title": "Properties",
1913
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
1914
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
1914
1915
  "items": { "$ref": "#/definitions/property" }
1915
1916
  },
1916
1917
  "tags": {
@@ -2009,12 +2010,14 @@
2009
2010
  "copyright": {
2010
2011
  "type": "object",
2011
2012
  "title": "Copyright",
2013
+ "description": "A copyright notice informing users of the underlying claims to copyright ownership in a published work.",
2012
2014
  "required": ["text"],
2013
2015
  "additionalProperties": false,
2014
2016
  "properties": {
2015
2017
  "text": {
2016
2018
  "type": "string",
2017
- "title": "Copyright Text"
2019
+ "title": "Copyright Text",
2020
+ "description": "The textual content of the copyright."
2018
2021
  }
2019
2022
  }
2020
2023
  },
@@ -2026,7 +2029,7 @@
2026
2029
  "properties": {
2027
2030
  "identity": {
2028
2031
  "title": "Identity Evidence",
2029
- "description": "Evidence that substantiates the identity of a component. The identify may be an object or an array of identity objects. Support for specifying identify as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is RECOMMENDED that all implementations use arrays, even if only one identity object is specified.",
2032
+ "description": "Evidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.",
2030
2033
  "oneOf": [
2031
2034
  {
2032
2035
  "type": "array",
@@ -2053,7 +2056,7 @@
2053
2056
  "bom-ref": {
2054
2057
  "$ref": "#/definitions/refType",
2055
2058
  "title": "BOM Reference",
2056
- "description": "An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
2059
+ "description": "An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
2057
2060
  },
2058
2061
  "location": {
2059
2062
  "type": "string",
@@ -2164,12 +2167,12 @@
2164
2167
  "bom-ref": {
2165
2168
  "$ref": "#/definitions/refType",
2166
2169
  "title": "BOM Reference",
2167
- "description": "An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
2170
+ "description": "An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
2168
2171
  },
2169
2172
  "aggregate": {
2170
2173
  "$ref": "#/definitions/aggregateType",
2171
2174
  "title": "Aggregate",
2172
- "description": "Specifies an aggregate type that describe how complete a relationship is."
2175
+ "description": "Specifies an aggregate type that describes how complete a relationship is."
2173
2176
  },
2174
2177
  "assemblies": {
2175
2178
  "type": "array",
@@ -2245,7 +2248,7 @@
2245
2248
  "property": {
2246
2249
  "type": "object",
2247
2250
  "title": "Lightweight name-value pair",
2248
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
2251
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
2249
2252
  "required": ["name"],
2250
2253
  "properties": {
2251
2254
  "name": {
@@ -2265,12 +2268,12 @@
2265
2268
  "type": "string",
2266
2269
  "pattern": "^([a-z]{2})(-[A-Z]{2})?$",
2267
2270
  "title": "Locale",
2268
- "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code MUST be lower case. If the country code is specified, the country code MUST be upper case. The language code and country code MUST be separated by a minus sign. Examples: en, en-US, fr, fr-CA"
2271
+ "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code must be lower case. If the country code is specified, the country code must be upper case. The language code and country code must be separated by a minus sign. Examples: en, en-US, fr, fr-CA"
2269
2272
  },
2270
2273
  "releaseType": {
2271
2274
  "type": "string",
2272
2275
  "examples": ["major", "minor", "patch", "pre-release", "internal"],
2273
- "description": "The software versioning type. It is RECOMMENDED that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it."
2276
+ "description": "The software versioning type. It is recommended that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it."
2274
2277
  },
2275
2278
  "note": {
2276
2279
  "type": "object",
@@ -2357,7 +2360,7 @@
2357
2360
  "properties": {
2358
2361
  "type": "array",
2359
2362
  "title": "Properties",
2360
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
2363
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
2361
2364
  "items": { "$ref": "#/definitions/property" }
2362
2365
  }
2363
2366
  }
@@ -2543,7 +2546,7 @@
2543
2546
  "bom-ref": {
2544
2547
  "$ref": "#/definitions/refType",
2545
2548
  "title": "BOM Reference",
2546
- "description": "An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
2549
+ "description": "An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
2547
2550
  },
2548
2551
  "id": {
2549
2552
  "type": "string",
@@ -2833,7 +2836,7 @@
2833
2836
  },
2834
2837
  "range": {
2835
2838
  "title": "Version Range",
2836
- "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst",
2839
+ "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst",
2837
2840
  "$ref": "#/definitions/versionRange"
2838
2841
  },
2839
2842
  "status": {
@@ -2853,7 +2856,7 @@
2853
2856
  "properties": {
2854
2857
  "type": "array",
2855
2858
  "title": "Properties",
2856
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
2859
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
2857
2860
  "items": {
2858
2861
  "$ref": "#/definitions/property"
2859
2862
  }
@@ -2884,7 +2887,7 @@
2884
2887
  ]
2885
2888
  },
2886
2889
  "versionRange": {
2887
- "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst",
2890
+ "description": "A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst",
2888
2891
  "type": "string",
2889
2892
  "minLength": 1,
2890
2893
  "maxLength": 4096,
@@ -2911,7 +2914,7 @@
2911
2914
  "bom-ref": {
2912
2915
  "$ref": "#/definitions/refType",
2913
2916
  "title": "BOM Reference",
2914
- "description": "An optional identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
2917
+ "description": "An optional identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
2915
2918
  },
2916
2919
  "subjects": {
2917
2920
  "type": "array",
@@ -2991,13 +2994,13 @@
2991
2994
  "$comment": "Model card support in CycloneDX is derived from TensorFlow Model Card Toolkit released under the Apache 2.0 license and available from https://github.com/tensorflow/model-card-toolkit/blob/main/model_card_toolkit/schema/v0.0.2/model_card.schema.json. In addition, CycloneDX model card support includes portions of VerifyML, also released under the Apache 2.0 license and available from https://github.com/cylynx/verifyml/blob/main/verifyml/model_card_toolkit/schema/v0.0.4/model_card.schema.json.",
2992
2995
  "type": "object",
2993
2996
  "title": "Model Card",
2994
- "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and MUST NOT be specified for other component types.",
2997
+ "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types.",
2995
2998
  "additionalProperties": false,
2996
2999
  "properties": {
2997
3000
  "bom-ref": {
2998
3001
  "$ref": "#/definitions/refType",
2999
3002
  "title": "BOM Reference",
3000
- "description": "An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
3003
+ "description": "An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
3001
3004
  },
3002
3005
  "modelParameters": {
3003
3006
  "type": "object",
@@ -3074,6 +3077,7 @@
3074
3077
  }
3075
3078
  ],
3076
3079
  "title": "Reference",
3080
+ "type": "string",
3077
3081
  "description": "References a data component by the components bom-ref attribute"
3078
3082
  }
3079
3083
  }
@@ -3172,7 +3176,7 @@
3172
3176
  "properties": {
3173
3177
  "type": "array",
3174
3178
  "title": "Properties",
3175
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
3179
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
3176
3180
  "items": { "$ref": "#/definitions/property" }
3177
3181
  }
3178
3182
  }
@@ -3198,7 +3202,7 @@
3198
3202
  "bom-ref": {
3199
3203
  "$ref": "#/definitions/refType",
3200
3204
  "title": "BOM Reference",
3201
- "description": "An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
3205
+ "description": "An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
3202
3206
  },
3203
3207
  "type": {
3204
3208
  "type": "string",
@@ -3306,10 +3310,12 @@
3306
3310
  "properties": {
3307
3311
  "organization": {
3308
3312
  "title": "Organization",
3313
+ "description": "The organization that is responsible for specific data governance role(s).",
3309
3314
  "$ref": "#/definitions/organizationalEntity"
3310
3315
  },
3311
3316
  "contact": {
3312
3317
  "title": "Individual",
3318
+ "description": "The individual that is responsible for specific data governance role(s).",
3313
3319
  "$ref": "#/definitions/organizationalContact"
3314
3320
  }
3315
3321
  },
@@ -3353,7 +3359,7 @@
3353
3359
  },
3354
3360
  "image": {
3355
3361
  "title": "Graphic Image",
3356
- "description": "The graphic (vector or raster). Base64 encoding MUST be specified for binary images.",
3362
+ "description": "The graphic (vector or raster). Base64 encoding must be specified for binary images.",
3357
3363
  "$ref": "#/definitions/attachment"
3358
3364
  }
3359
3365
  }
@@ -3465,6 +3471,7 @@
3465
3471
  "properties": {
3466
3472
  "type": "array",
3467
3473
  "title": "Properties",
3474
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
3468
3475
  "items": {
3469
3476
  "$ref": "#/definitions/property"
3470
3477
  }
@@ -3529,6 +3536,7 @@
3529
3536
  "properties": {
3530
3537
  "type": "array",
3531
3538
  "title": "Properties",
3539
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
3532
3540
  "items": {
3533
3541
  "$ref": "#/definitions/property"
3534
3542
  }
@@ -3590,7 +3598,7 @@
3590
3598
  "properties": {
3591
3599
  "bom-ref": {
3592
3600
  "title": "BOM Reference",
3593
- "description": "An optional identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3601
+ "description": "An optional identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3594
3602
  "$ref": "#/definitions/refType"
3595
3603
  },
3596
3604
  "description": {
@@ -3601,6 +3609,7 @@
3601
3609
  "organization": {
3602
3610
  "type": "object",
3603
3611
  "title": "Organization",
3612
+ "description": "The organization that provides energy.",
3604
3613
  "$ref": "#/definitions/organizationalEntity"
3605
3614
  },
3606
3615
  "energySource": {
@@ -3655,7 +3664,7 @@
3655
3664
  "properties": {
3656
3665
  "bom-ref": {
3657
3666
  "title": "BOM Reference",
3658
- "description": "An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3667
+ "description": "An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3659
3668
  "$ref": "#/definitions/refType"
3660
3669
  },
3661
3670
  "country": {
@@ -3703,7 +3712,7 @@
3703
3712
  "properties": {
3704
3713
  "bom-ref": {
3705
3714
  "title": "BOM Reference",
3706
- "description": "An optional identifier which can be used to reference the formula elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3715
+ "description": "An optional identifier which can be used to reference the formula elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3707
3716
  "$ref": "#/definitions/refType"
3708
3717
  },
3709
3718
  "components": {
@@ -3737,6 +3746,7 @@
3737
3746
  "properties": {
3738
3747
  "type": "array",
3739
3748
  "title": "Properties",
3749
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
3740
3750
  "items": {
3741
3751
  "$ref": "#/definitions/property"
3742
3752
  }
@@ -3753,7 +3763,7 @@
3753
3763
  "properties": {
3754
3764
  "bom-ref": {
3755
3765
  "title": "BOM Reference",
3756
- "description": "An optional identifier which can be used to reference the workflow elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3766
+ "description": "An optional identifier which can be used to reference the workflow elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3757
3767
  "$ref": "#/definitions/refType"
3758
3768
  },
3759
3769
  "uid": {
@@ -3878,6 +3888,7 @@
3878
3888
  "properties": {
3879
3889
  "type": "array",
3880
3890
  "title": "Properties",
3891
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
3881
3892
  "items": {
3882
3893
  "$ref": "#/definitions/property"
3883
3894
  }
@@ -3894,7 +3905,7 @@
3894
3905
  "properties": {
3895
3906
  "bom-ref": {
3896
3907
  "title": "BOM Reference",
3897
- "description": "An optional identifier which can be used to reference the task elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3908
+ "description": "An optional identifier which can be used to reference the task elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
3898
3909
  "$ref": "#/definitions/refType"
3899
3910
  },
3900
3911
  "uid": {
@@ -4000,6 +4011,7 @@
4000
4011
  "properties": {
4001
4012
  "type": "array",
4002
4013
  "title": "Properties",
4014
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4003
4015
  "items": {
4004
4016
  "$ref": "#/definitions/property"
4005
4017
  }
@@ -4032,6 +4044,7 @@
4032
4044
  "properties": {
4033
4045
  "type": "array",
4034
4046
  "title": "Properties",
4047
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4035
4048
  "items": {
4036
4049
  "$ref": "#/definitions/property"
4037
4050
  }
@@ -4050,6 +4063,7 @@
4050
4063
  "properties": {
4051
4064
  "type": "array",
4052
4065
  "title": "Properties",
4066
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4053
4067
  "items": {
4054
4068
  "$ref": "#/definitions/property"
4055
4069
  }
@@ -4065,7 +4079,7 @@
4065
4079
  "properties": {
4066
4080
  "bom-ref": {
4067
4081
  "title": "BOM Reference",
4068
- "description": "An optional identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
4082
+ "description": "An optional identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
4069
4083
  "$ref": "#/definitions/refType"
4070
4084
  },
4071
4085
  "uid": {
@@ -4140,6 +4154,7 @@
4140
4154
  "properties": {
4141
4155
  "type": "array",
4142
4156
  "title": "Properties",
4157
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4143
4158
  "items": {
4144
4159
  "$ref": "#/definitions/property"
4145
4160
  }
@@ -4193,6 +4208,7 @@
4193
4208
  "properties": {
4194
4209
  "type": "array",
4195
4210
  "title": "Properties",
4211
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4196
4212
  "items": {
4197
4213
  "$ref": "#/definitions/property"
4198
4214
  }
@@ -4208,7 +4224,7 @@
4208
4224
  "properties": {
4209
4225
  "bom-ref": {
4210
4226
  "title": "BOM Reference",
4211
- "description": "An optional identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
4227
+ "description": "An optional identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
4212
4228
  "$ref": "#/definitions/refType"
4213
4229
  },
4214
4230
  "uid": {
@@ -4249,6 +4265,7 @@
4249
4265
  "conditions": {
4250
4266
  "type": "array",
4251
4267
  "title": "Conditions",
4268
+ "description": "A list of conditions used to determine if a trigger should be activated.",
4252
4269
  "uniqueItems": true,
4253
4270
  "items": {
4254
4271
  "$ref": "#/definitions/condition"
@@ -4285,6 +4302,7 @@
4285
4302
  "properties": {
4286
4303
  "type": "array",
4287
4304
  "title": "Properties",
4305
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4288
4306
  "items": {
4289
4307
  "$ref": "#/definitions/property"
4290
4308
  }
@@ -4331,6 +4349,7 @@
4331
4349
  "properties": {
4332
4350
  "type": "array",
4333
4351
  "title": "Properties",
4352
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4334
4353
  "items": {
4335
4354
  "$ref": "#/definitions/property"
4336
4355
  }
@@ -4411,6 +4430,7 @@
4411
4430
  "properties": {
4412
4431
  "type": "array",
4413
4432
  "title": "Properties",
4433
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4414
4434
  "items": {
4415
4435
  "$ref": "#/definitions/property"
4416
4436
  }
@@ -4488,6 +4508,7 @@
4488
4508
  "properties": {
4489
4509
  "type": "array",
4490
4510
  "title": "Properties",
4511
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4491
4512
  "items": {
4492
4513
  "$ref": "#/definitions/property"
4493
4514
  }
@@ -4549,6 +4570,7 @@
4549
4570
  "properties": {
4550
4571
  "type": "array",
4551
4572
  "title": "Properties",
4573
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4552
4574
  "items": {
4553
4575
  "$ref": "#/definitions/property"
4554
4576
  }
@@ -4714,7 +4736,7 @@
4714
4736
  "bom-ref": {
4715
4737
  "$ref": "#/definitions/refType",
4716
4738
  "title": "BOM Reference",
4717
- "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
4739
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
4718
4740
  },
4719
4741
  "name": {
4720
4742
  "type": "string",
@@ -4748,7 +4770,7 @@
4748
4770
  "bom-ref": {
4749
4771
  "$ref": "#/definitions/refType",
4750
4772
  "title": "BOM Reference",
4751
- "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
4773
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
4752
4774
  },
4753
4775
  "identifier": {
4754
4776
  "type": "string",
@@ -4789,7 +4811,7 @@
4789
4811
  "properties": {
4790
4812
  "type": "array",
4791
4813
  "title": "Properties",
4792
- "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is OPTIONAL.",
4814
+ "description": "Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.",
4793
4815
  "items": {
4794
4816
  "$ref": "#/definitions/property"
4795
4817
  }
@@ -4815,7 +4837,7 @@
4815
4837
  "bom-ref": {
4816
4838
  "$ref": "#/definitions/refType",
4817
4839
  "title": "BOM Reference",
4818
- "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref MUST be unique within the BOM."
4840
+ "description": "An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."
4819
4841
  },
4820
4842
  "identifier": {
4821
4843
  "type": "string",
@@ -4961,7 +4983,7 @@
4961
4983
  },
4962
4984
  "implementationPlatform": {
4963
4985
  "type": "string",
4964
- "title": "implementation platform",
4986
+ "title": "Implementation platform",
4965
4987
  "description": "The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.",
4966
4988
  "enum": [
4967
4989
  "generic",
@@ -5361,7 +5383,7 @@
5361
5383
  "ikev2TransformTypes": {
5362
5384
  "type": "object",
5363
5385
  "title": "IKEv2 Transform Types",
5364
- "description": "The IKEv2 transform types supported (types 1-4), defined in RFC7296 section 3.3.2, and additional properties.",
5386
+ "description": "The IKEv2 transform types supported (types 1-4), defined in [RFC 7296 section 3.3.2](https://www.ietf.org/rfc/rfc7296.html#section-3.3.2), and additional properties.",
5365
5387
  "additionalProperties": false,
5366
5388
  "properties": {
5367
5389
  "encr": {
@@ -5382,7 +5404,7 @@
5382
5404
  "ke": {
5383
5405
  "$ref": "#/definitions/cryptoRefArray",
5384
5406
  "title": "Key Exchange Method (KE)",
5385
- "description": "Transform Type 4: Key Exchange Method (KE) per RFC9370, formerly called Diffie-Hellman Group (D-H)"
5407
+ "description": "Transform Type 4: Key Exchange Method (KE) per [RFC 9370](https://www.ietf.org/rfc/rfc9370.html), formerly called Diffie-Hellman Group (D-H)."
5386
5408
  },
5387
5409
  "esn": {
5388
5410
  "type": "boolean",