Skip to content

Conversation

@wiebe-vandendriessche
Copy link

As discussed in ticket #726 and in CycloneDX/cyclonedx-python-lib#914, this PR fixes a schema mismatch where modelCard supports properties in JSON but was missing it in XML and Protobuf.

Changes:

Add optional properties to modelCardType in XML schemas: bom-1.5.xsd, bom-1.6.xsd, bom-1.7.xsd
Add properties to ModelCard Protobuf message: bom-1.5.proto, bom-1.6.proto, bom-1.7.proto

This is backward compatible (adds optional fields only).

fixes #726

…tch with json

Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
@wiebe-vandendriessche wiebe-vandendriessche marked this pull request as ready for review December 17, 2025 10:03
@wiebe-vandendriessche wiebe-vandendriessche requested a review from a team as a code owner December 17, 2025 10:03
@wiebe-vandendriessche wiebe-vandendriessche marked this pull request as draft December 17, 2025 10:03
@jkowalleck jkowalleck requested a review from Copilot January 15, 2026 13:03
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR addresses a schema inconsistency where modelCard supported a properties field in JSON schemas but was missing it in the XML (XSD) and Protobuf schemas. The fix adds the optional properties field to all three schema formats across versions 1.5, 1.6, and 1.7.

Changes:

  • Added optional properties element to modelCardType in XML schemas for versions 1.5, 1.6, and 1.7
  • Added properties field (field number 5) to ModelCard message in Protobuf schemas for versions 1.5, 1.6, and 1.7

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
schema/bom-1.5.xsd Added optional properties element to modelCardType definition
schema/bom-1.5.proto Added properties field (number 5) to ModelCard message
schema/bom-1.6.xsd Added optional properties element to modelCardType definition
schema/bom-1.6.proto Added properties field (number 5) to ModelCard message
schema/bom-1.7.xsd Added optional properties element to modelCardType definition
schema/bom-1.7.proto Added properties field (number 5) to ModelCard message

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
@wiebe-vandendriessche wiebe-vandendriessche force-pushed the fix/modelcard-missing-properties branch from 5ade14e to f1b7301 Compare January 15, 2026 14:25
@wiebe-vandendriessche wiebe-vandendriessche marked this pull request as ready for review January 15, 2026 14:32
@jkowalleck jkowalleck requested a review from Copilot January 15, 2026 16:38
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…proto)

Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 15 out of 15 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Defect]: modelCard misisng properties in XML & ProtoBuff

1 participant