From 4e926964477ee21306f4bb496f4c4adfd0a3de88 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Tue, 8 Sep 2026 17:49:10 +0200 Subject: [PATCH] streamline bom-ref descriptions Signed-off-by: Jan Kowalleck --- .../2.0/model/cyclonedx-ai-modelcard-2.0.schema.json | 4 ++-- schema/2.0/model/cyclonedx-annotation-2.0.schema.json | 2 +- .../2.0/model/cyclonedx-certification-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-common-2.0.schema.json | 8 ++++---- schema/2.0/model/cyclonedx-component-2.0.schema.json | 10 +++++----- schema/2.0/model/cyclonedx-composition-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-evidence-2.0.schema.json | 6 +++--- schema/2.0/model/cyclonedx-formulation-2.0.schema.json | 10 +++++----- schema/2.0/model/cyclonedx-license-2.0.schema.json | 6 +++--- schema/2.0/model/cyclonedx-party-2.0.schema.json | 2 +- .../2.0/model/cyclonedx-vulnerability-2.0.schema.json | 4 ++-- 11 files changed, 28 insertions(+), 28 deletions(-) diff --git a/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json b/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json index 5bb062879..4550f81d3 100644 --- a/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json @@ -15,7 +15,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the model card elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "modelParameters": { "type": "object", @@ -355,7 +355,7 @@ "properties": { "bom-ref": { "title": "BOM Reference", - "description": "An 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.", + "description": "An identifier which can be used to reference the energy provider elsewhere in the BOM. Every `bom-ref` must be unique within the BOM.", "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType" }, "description": { diff --git a/schema/2.0/model/cyclonedx-annotation-2.0.schema.json b/schema/2.0/model/cyclonedx-annotation-2.0.schema.json index 7816fedbe..a9e870365 100644 --- a/schema/2.0/model/cyclonedx-annotation-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-annotation-2.0.schema.json @@ -27,7 +27,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the annotation elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "subjects": { "type": "array", diff --git a/schema/2.0/model/cyclonedx-certification-2.0.schema.json b/schema/2.0/model/cyclonedx-certification-2.0.schema.json index 05c08f0e8..731a10e31 100644 --- a/schema/2.0/model/cyclonedx-certification-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-certification-2.0.schema.json @@ -21,7 +21,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An optional identifier that can be used to reference the certification from elsewhere. Every bom-ref shall be unique within the containing instance. The value should not start with the prefix `urn:cdx:` to avoid conflicts with BOM-Link identifiers." + "description": "An optional identifier that can be used to reference the certification from elsewhere. Every bom-ref shall be unique within the containing instance." }, "standard": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-common-2.0.schema.json b/schema/2.0/model/cyclonedx-common-2.0.schema.json index 6e53d544b..b7a537481 100644 --- a/schema/2.0/model/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-common-2.0.schema.json @@ -6,7 +6,7 @@ "$comment" : "OWASP CycloneDX is an Ecma International standard (ECMA-424) developed in collaboration between the OWASP Foundation and Ecma Technical Committee 54 (TC54). The standard is published under a royalty-free patent policy. This JSON schema is the reference implementation and is licensed under the Apache License 2.0.", "$defs": { "refType": { - "description": "Identifier for referable and therefore interlinkable elements.\nValue shall not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.", + "description": "Identifier for referable and therefore interlinkable elements. Value shall be unique within the BOM. \nValue shall not start with the BOM-Link intro `\"urn:cdx:\"` to avoid conflicts with BOM-Links.", "type": "string", "minLength": 1, "pattern": "^(?!urn:cdx:)" @@ -318,7 +318,7 @@ "properties": { "bom-ref": { "title": "BOM Reference", - "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.", + "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.", "$ref": "#/$defs/refType" }, "country": { @@ -366,7 +366,7 @@ "bom-ref": { "$ref": "#/$defs/refType", "title": "BOM Reference", - "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." + "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." }, "name": { "type": "string", @@ -414,7 +414,7 @@ "bom-ref": { "$ref": "#/$defs/refType", "title": "BOM Reference", - "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." + "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." }, "name": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-component-2.0.schema.json b/schema/2.0/model/cyclonedx-component-2.0.schema.json index af1b29efd..0a32bb1db 100644 --- a/schema/2.0/model/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-component-2.0.schema.json @@ -70,7 +70,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the component elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "parties": { "$ref": "cyclonedx-party-2.0.schema.json#/$defs/parties" @@ -408,7 +408,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An identifier which can be used to reference the component-choice 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." + "description": "An identifier which can be used to reference the component-choice elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "name": { "type": "string", @@ -533,7 +533,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An identifier which can be used to reference this license evidence 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." + "description": "An identifier which can be used to reference this license evidence elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "license": { "allOf": [ @@ -610,7 +610,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An identifier which can be used to reference this copyright evidence 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." + "description": "An identifier which can be used to reference this copyright evidence elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "text": { "type": "string", @@ -719,7 +719,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the dataset elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "type": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-composition-2.0.schema.json b/schema/2.0/model/cyclonedx-composition-2.0.schema.json index 6ff555a10..42242f2dd 100644 --- a/schema/2.0/model/cyclonedx-composition-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-composition-2.0.schema.json @@ -23,7 +23,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the composition elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "aggregate": { "$ref": "#/$defs/aggregateType", diff --git a/schema/2.0/model/cyclonedx-evidence-2.0.schema.json b/schema/2.0/model/cyclonedx-evidence-2.0.schema.json index bfaf446ed..2ce8b4195 100644 --- a/schema/2.0/model/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-evidence-2.0.schema.json @@ -17,7 +17,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the occurrence elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "location": { "type": "string", @@ -91,7 +91,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An identifier which can be used to reference this call stack 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." + "description": "An identifier which can be used to reference this call stack elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "name": { "type": "string", @@ -214,7 +214,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An identifier which can be used to reference the rule elsewhere in the BOM, for example when the same rule produces many findings. 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." + "description": "An identifier which can be used to reference the rule elsewhere in the BOM, for example when the same rule produces many findings. Every `bom-ref` must be unique within the BOM." }, "id": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-formulation-2.0.schema.json b/schema/2.0/model/cyclonedx-formulation-2.0.schema.json index 997dc6d9e..afce22af0 100644 --- a/schema/2.0/model/cyclonedx-formulation-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-formulation-2.0.schema.json @@ -20,7 +20,7 @@ "properties": { "bom-ref": { "title": "BOM Reference", - "description": "An 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.", + "description": "An identifier which can be used to reference the formula elsewhere in the BOM. Every `bom-ref` must be unique within the BOM.", "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType" }, "components": { @@ -61,7 +61,7 @@ "properties": { "bom-ref": { "title": "BOM Reference", - "description": "An 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.", + "description": "An identifier which can be used to reference the workflow elsewhere in the BOM. Every `bom-ref` must be unique within the BOM.", "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType" }, "uid": { @@ -200,7 +200,7 @@ "properties": { "bom-ref": { "title": "BOM Reference", - "description": "An 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.", + "description": "An identifier which can be used to reference the task elsewhere in the BOM. Every `bom-ref` must be unique within the BOM.", "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType" }, "uid": { @@ -360,7 +360,7 @@ "properties": { "bom-ref": { "title": "BOM Reference", - "description": "An 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.", + "description": "An identifier which can be used to reference the workspace elsewhere in the BOM. Every `bom-ref` must be unique within the BOM.", "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType" }, "uid": { @@ -499,7 +499,7 @@ "properties": { "bom-ref": { "title": "BOM Reference", - "description": "An 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.", + "description": "An identifier which can be used to reference the trigger elsewhere in the BOM. Every `bom-ref` must be unique within the BOM.", "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType" }, "uid": { diff --git a/schema/2.0/model/cyclonedx-license-2.0.schema.json b/schema/2.0/model/cyclonedx-license-2.0.schema.json index 2faa5543a..9a030191d 100644 --- a/schema/2.0/model/cyclonedx-license-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-license-2.0.schema.json @@ -66,7 +66,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the license elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "text": { "title": "License texts", @@ -92,7 +92,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the license elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "licensing": { "$ref": "#/$defs/licensing" @@ -124,7 +124,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the license elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "id": { "$ref": "../../spdx.schema.json", diff --git a/schema/2.0/model/cyclonedx-party-2.0.schema.json b/schema/2.0/model/cyclonedx-party-2.0.schema.json index b38625c8e..9ccb655cd 100644 --- a/schema/2.0/model/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-party-2.0.schema.json @@ -851,7 +851,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "Reference Identifier", - "description": "An optional identifier that can be used to reference the address from elsewhere. Every bom-ref shall be unique within the containing instance. The value should not start with the prefix 'urn:cdx:' to avoid conflicts with BOM-Link identifiers." + "description": "An optional identifier that can be used to reference the address from elsewhere. Every bom-ref shall be unique within the containing instance." }, "country": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json b/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json index 42204323f..461df54e3 100644 --- a/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json @@ -21,7 +21,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An 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." + "description": "An identifier which can be used to reference the vulnerability elsewhere in the BOM. Every `bom-ref` must be unique within the BOM." }, "id": { "type": "string", @@ -554,7 +554,7 @@ "bom-ref": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType", "title": "BOM Reference", - "description": "An identifier which can be used to reference this evidence elsewhere in the BOM, for example from an attestation claim that relies upon it. 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." + "description": "An identifier which can be used to reference this evidence elsewhere in the BOM, for example from an attestation claim that relies upon it. Every `bom-ref` must be unique within the BOM." }, "ref": { "anyOf": [