Skip to content

Changed bom-ref to refId. Title and description updated. Updated test… #1113

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
stevespringett wants to merge 3 commits into
base: 2.0-dev
Choose a base branch
from
Open

Changed bom-ref to refId. Title and description updated. Updated test… #1113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
66d652d
Changed bom-ref to refId. Title and description updated. Updated test…
stevespringett Sep 17, 2026
308d272
Merge branch '2.0-dev' into 2.0-dev-refId
jkowalleck Sep 18, 2026
97df98c
Renamed refType to refIdType
stevespringett Sep 18, 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
2 changes: 1 addition & 1 deletion schema/2.0/cyclonedx-2.0-bundled.min.schema.json
View file
Open in desktop

Large diffs are not rendered by default.

888 changes: 444 additions & 444 deletions schema/2.0/cyclonedx-2.0-bundled.schema.json
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 9 additions & 9 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 @@ -12,10 +12,10 @@
"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.",
"additionalProperties": false,
"properties": {
"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."
"refId": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType",
"title": "Reference Identifier",
"description": "An identifier which can be used to reference the model card elsewhere in the BOM. Every `refId` must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
},
"modelParameters": {
"type": "object",
Expand Down Expand Up @@ -82,7 +82,7 @@
"ref": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/elementLink",
"title": "Reference",
"description": "References a data component by the components bom-ref attribute"
"description": "References a data component by the components refId attribute"
}
}
}
Expand Down Expand Up @@ -348,10 +348,10 @@
],
"additionalProperties": false,
"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.",
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType"
"refId": {
"title": "Reference Identifier",
"description": "An identifier which can be used to reference the energy provider elsewhere in the BOM. Every `refId` must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.",
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType"
},
"description": {
"type": "string",
Expand Down
12 changes: 6 additions & 6 deletions 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 @@ -10,7 +10,7 @@
"items": {"$ref": "#/$defs/annotation"},
"uniqueItems": true,
"title": "Annotations",
"description": "Comments made by people, organizations, or tools about any object with a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinions or commentary from various stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link and may optionally be signed."
"description": "Comments made by people, organizations, or tools about any object with a refId, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinions or commentary from various stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link and may optionally be signed."
},
"annotation": {
"type": "object",
Expand All @@ -24,10 +24,10 @@
],
"additionalProperties": false,
"properties": {
"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."
"refId": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType",
"title": "Reference Identifier",
"description": "An identifier which can be used to reference the annotation elsewhere in the BOM. Every `refId` must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."
},
"subjects": {
"type": "array",
Expand All @@ -36,7 +36,7 @@
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/elementLink"
},
"title": "Subjects",
"description": "The object in the BOM identified by its bom-ref. This is often a component or service, but may be any object type supporting bom-refs."
"description": "The object in the BOM identified by its refId. This is often a component or service, but may be any object type supporting refIds."
},
"annotator": {
"type": "object",
Expand Down
32 changes: 16 additions & 16 deletions schema/2.0/model/cyclonedx-behavior-2.0.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@
"title": "Behavior Instance",
"description": "A behavior performed by one or more objects within the BOM.",
"additionalProperties": false,
"required": ["bom-ref", "behavior"],
"required": ["refId", "behavior"],
"properties": {
"bom-ref": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType"
"refId": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType"
},
"behavior": {
"$ref": "../../behavior-taxonomy.schema.json",
Expand All @@ -55,7 +55,7 @@
"actors": {
"type": "array",
"title": "Actors",
"description": "References using bom-link or bom-ref to objects that perform this behavior.",
"description": "References using bom-link or refId to objects that perform this behavior.",

@jkowalleck jkowalleck Sep 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe out of scope but a good situation to do this: in the docs: make sure all ref are marked a code.

Suggested change
"description": "References using bom-link or refId to objects that perform this behavior.",
"description": "References using bom-link or `refId` to objects that perform this behavior.",

Ir if not in scope, create a follow-up ticket from this comment.

@jkowalleck jkowalleck Sep 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe out of scope but a good situation to do this:
make sure all BOM-Link are stylized correctly.

Suggested change
"description": "References using bom-link or refId to objects that perform this behavior.",
"description": "References using BOM-link or refId to objects that perform this behavior.",

Ir if not in scope, create a follow-up ticket from this comment.

"uniqueItems": true,
"items": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType"
Expand All @@ -64,7 +64,7 @@
"targets": {
"type": "array",
"title": "Targets",
"description": "References using bom-link or bom-ref to objects affected by this behavior.",
"description": "References using bom-link or refId to objects affected by this behavior.",
"uniqueItems": true,
"items": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType"
Expand Down Expand Up @@ -138,12 +138,12 @@
"description": "A graph of nodes joined by transitions that models behaviour over time. A node may be an activity, a state, an event, a gateway, or a start or end point, so the same construct expresses an activity or process flow (where the nodes are activities), a state machine (where the nodes are states), or a mixture of the two.",
"additionalProperties": false,
"required": [
"bom-ref",
"refId",
"nodes"
],
"properties": {
"bom-ref": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType"
"refId": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType"
},
"name": {
"type": "string",
Expand Down Expand Up @@ -172,7 +172,7 @@
"subject": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType",
"title": "Subject",
"description": "Reference using bom-link or bom-ref to the object whose behaviour this graph describes."
"description": "Reference using bom-link or refId to the object whose behaviour this graph describes."
},
"acknowledgment": {
"$ref": "#/$defs/acknowledgment"
Expand Down Expand Up @@ -241,12 +241,12 @@
"description": "A single node in a behavior graph. The kind determines what the node represents and which additional properties apply.",
"additionalProperties": false,
"required": [
"bom-ref",
"refId",
"kind"
],
"properties": {
"bom-ref": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType"
"refId": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType"
},
"kind": {
"title": "Kind",
Expand Down Expand Up @@ -302,7 +302,7 @@
"actors": {
"type": "array",
"title": "Actors",
"description": "References using bom-link or bom-ref to objects that perform this node.",
"description": "References using bom-link or refId to objects that perform this node.",
"uniqueItems": true,
"items": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType"
Expand All @@ -311,7 +311,7 @@
"targets": {
"type": "array",
"title": "Targets",
"description": "References using bom-link or bom-ref to objects affected by this node.",
"description": "References using bom-link or refId to objects affected by this node.",
"uniqueItems": true,
"items": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType"
Expand Down Expand Up @@ -386,8 +386,8 @@
"target"
],
"properties": {
"bom-ref": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refType"
"refId": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType"
},
"name": {
"type": "string",
Expand Down
Loading
Loading