Skip to content

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

Open
stevespringett wants to merge 3 commits into
2.0-devfrom
2.0-dev-refId
Open

stevespringett wants to merge 3 commits into
2.0-devfrom
2.0-dev-refId

Conversation

@stevespringett

@stevespringett stevespringett commented Sep 17, 2026

Copy link
Copy Markdown
Member

… cases.

Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett stevespringett added this to the 2.0 milestone Sep 17, 2026
@stevespringett stevespringett self-assigned this Sep 17, 2026
@stevespringett
stevespringett requested a review from a team as a code owner September 17, 2026 21:50
@stevespringett stevespringett linked an issue Sep 17, 2026 that may be closed by this pull request
@stevespringett stevespringett added request for comment RFC notice sent A public RFC notice was distributed to the CycloneDX mailing list for consideration labels Sep 17, 2026
@jkowalleck

Copy link
Copy Markdown
Member

RFC notice sent on September 18, 2026

Public RFC period ends October 16, 2026

"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.",

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.

"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.",

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.

@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.

Please consider renaming cyclonedx-common-2.0.schema.json#/$defs/refType
to cyclonedx-common-2.0.schema.json#/$defs/refIdType

I think this is the right scope for this, since the refType is the root of all the refId, and should follow the new naming schema.

@oej

oej commented Sep 18, 2026

Copy link
Copy Markdown

Good change. Approved. /O

Signed-off-by: Steve Springett <steve@springett.us>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking-changes proposed core enhancement request for comment RFC notice sent A public RFC notice was distributed to the CycloneDX mailing list for consideration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consider changing bom-ref to bom-id in 2.0

3 participants