Skip to content

CycloneDX 1.7.1 - Schema Alignment & Typo-/Bug‑Fix Release#932

Open
jkowalleck wants to merge 22 commits into
masterfrom
1.7.1-dev
Open

CycloneDX 1.7.1 - Schema Alignment & Typo-/Bug‑Fix Release#932
jkowalleck wants to merge 22 commits into
masterfrom
1.7.1-dev

Conversation

@jkowalleck
Copy link
Copy Markdown
Member

@jkowalleck jkowalleck commented May 18, 2026

Fixed – Schema Alignment

  • Protobuf: added the optional, repeated field ModelCard.property (#726 via #743)
  • XML: added the optional, repeated node //modelCard/properties (#726 via #743)
  • XML: changed the node //modelCard/considerations/users/user from optional to optional and repeated (#737 via #744)
  • XML: changed the node //modelCard/considerations/useCases/useCase from optional to optional and repeated (#737 via #744)
  • XML: changed the node //modelCard/considerations/technicalLimitations/technicalLimitation from optional to optional and repeated (#737 via #744)
  • XML: changed the node //modelCard/considerations/performanceTradeoffs/performanceTradeoff from optional to optional and repeated (#737 via #744)

Tests

  • Added test cases for the updated schemas.


progress: https://github.com/CycloneDX/specification/milestone/13

intended release: v1.7.1

backports:

wiebe-vandendriessche and others added 18 commits December 17, 2025 10:38
…tch with json

Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
… (so it matches the json spec)

Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
performanceTradeoffs in valid-machine-learning-*.xml test files to
verify the schema correctly validates multiple entries for these fields.

Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
…proto)

Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
…roto files

Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
Signed-off-by: wievdndr <wiebe.vandendriessche@ugent.be>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck self-assigned this May 18, 2026
@jkowalleck jkowalleck added this to the 1.7.1 milestone May 18, 2026
@jkowalleck jkowalleck changed the title [WIP] 1.7.1 [WIP] CycloneDX 1.7.1 - Schema Alignment & Typo-/Bug‑Fix Release May 18, 2026
@jkowalleck jkowalleck added the CDX 1.7 related to release v1.7 label May 18, 2026
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
…#744)

As discussed in ticket #737, the XML schema incorrectly restricts
several ModelCard.Considerations list fields to a single entry. The JSON
schema defines these fields as arrays, and other ModelCard list fields
already allow multiple entries.

This PR updates the XML schemas (1.5, 1.6, 1.7) so the following
elements can contain multiple entries:

`users/user`
`useCases/useCase`
`technicalLimitations/technicalLimitation`
`performanceTradeoffs/performanceTradeoff`

Additionally, the XML schema version attributes are bumped (patch-only)
to reflect the schema change.

fixes #737
@jkowalleck jkowalleck changed the title [WIP] CycloneDX 1.7.1 - Schema Alignment & Typo-/Bug‑Fix Release CycloneDX 1.7.1 - Schema Alignment & Typo-/Bug‑Fix Release May 19, 2026
@jkowalleck jkowalleck marked this pull request as ready for review May 19, 2026 09:36
@jkowalleck jkowalleck requested a review from a team as a code owner May 19, 2026 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment