Skip to content

streamline bom-ref descriptions #1091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jkowalleck wants to merge 2 commits into
base: 2.0-dev
Choose a base branch
from
Open

streamline bom-ref descriptions #1091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e92696
streamline bom-ref descriptions
jkowalleck Sep 8, 2026
7129cbc
Merge branch '2.0-dev' into 2.0-dev_streamline-bomref
jkowalleck Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -354,7 +354,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": {
Expand Down
2 changes: 1 addition & 1 deletion schema/2.0/model/cyclonedx-annotation-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion schema/2.0/model/cyclonedx-certification-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
8 changes: 4 additions & 4 deletions schema/2.0/model/cyclonedx-common-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:)"
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
10 changes: 5 additions & 5 deletions schema/2.0/model/cyclonedx-component-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion schema/2.0/model/cyclonedx-composition-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 3 additions & 3 deletions schema/2.0/model/cyclonedx-evidence-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
10 changes: 5 additions & 5 deletions schema/2.0/model/cyclonedx-formulation-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
6 changes: 3 additions & 3 deletions schema/2.0/model/cyclonedx-license-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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"
Expand Down Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion schema/2.0/model/cyclonedx-party-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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": [
Expand Down
Loading