Skip to content
Draft
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
eac0ac6
Initial commit
stevespringett Jun 15, 2025
028c9df
Merge remote-tracking branch 'origin/master' into 2.0-dev
stevespringett Nov 11, 2025
bde33b2
Syncing with master
stevespringett Nov 11, 2025
dae213a
Revert "Syncing with master"
stevespringett Nov 11, 2025
fbaf3de
Added schema bundler and updated readme.
stevespringett Nov 11, 2025
0d74d96
Adding GitHub Action to combine schemas
stevespringett Nov 11, 2025
51fbf49
Updated branches
stevespringett Nov 11, 2025
b4721e1
Updating action
stevespringett Nov 12, 2025
91ec8e0
chore: update bundled schema [skip ci]
github-actions[bot] Nov 12, 2025
c4d6c82
Updated docgen for 2.0
stevespringett Nov 12, 2025
b6fed22
Added minified bundling
stevespringett Nov 12, 2025
173a276
chore: update bundled schemas [skip ci]
github-actions[bot] Nov 12, 2025
0427839
Added further optimization to minified version
stevespringett Nov 12, 2025
8668856
chore: update bundled schemas [skip ci]
github-actions[bot] Nov 12, 2025
c46624c
Fixed resolution issues
stevespringett Nov 24, 2025
ed3eb38
chore: update bundled schemas [skip ci]
github-actions[bot] Nov 24, 2025
7aceff4
Added ref verification
stevespringett Nov 24, 2025
70ea2fa
Merge remote-tracking branch 'origin/2.0-dev' into 2.0-dev
stevespringett Nov 24, 2025
dd45ceb
Updated JSON Schema for Humans
stevespringett Nov 25, 2025
b8abb0c
Initial commit of CycloneDX linter
stevespringett Nov 29, 2025
f0c447b
Moved bundler
stevespringett Nov 29, 2025
41ad354
Added lock file
stevespringett Nov 29, 2025
319ed73
Omitting a few properties from being bundled.
stevespringett Nov 30, 2025
47f0ec2
chore: update bundled schemas [skip ci]
github-actions[bot] Nov 30, 2025
f0fcf97
Added comment check
stevespringett Nov 30, 2025
625b757
Added schema version check
stevespringett Nov 30, 2025
90de7cd
Ported metadata minus deprecations.
stevespringett Nov 30, 2025
38547b6
Ported multiple models minus deprecations and standardized id and com…
stevespringett Dec 1, 2025
9be3484
Ported model card
stevespringett Dec 1, 2025
4e77988
Updating indent check. Added two new checks.
stevespringett Dec 1, 2025
08e4936
Updating readme
stevespringett Dec 1, 2025
666b40d
Updating readme
stevespringett Dec 1, 2025
7f3c089
Ported dependency and composition objects
stevespringett Dec 1, 2025
4456b54
Updated title
stevespringett Dec 1, 2025
ce23470
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
0f9f07f
Ported vulnerability model
stevespringett Dec 1, 2025
17daf80
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
976a9d2
Ported annotation model
stevespringett Dec 1, 2025
80cf0cc
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
8237c95
Ported formulation model
stevespringett Dec 1, 2025
98a2ce7
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
c1c1e03
Ported declaration model
stevespringett Dec 1, 2025
9575876
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
37e04be
Ported definition and standard model. Updated patent model.
stevespringett Dec 1, 2025
f2e7bb2
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
cbba940
Ported citation model.
stevespringett Dec 1, 2025
9a09935
Added remaining root objects.
stevespringett Dec 1, 2025
43945b5
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
93f57a5
Removed properties from license. Removed unused model files.
stevespringett Dec 1, 2025
1caff3e
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
5012f06
Removed extensible properties to root object.
stevespringett Dec 1, 2025
66cd80e
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
c23f59b
Ported service model.
stevespringett Dec 1, 2025
691bc49
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 1, 2025
2d9b07a
Fixed extensibleProperties defect preventing validation
stevespringett Dec 2, 2025
7ddf4b8
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 2, 2025
da1b173
Fixed properties defect.
stevespringett Dec 2, 2025
dde65f3
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 2, 2025
57beb2e
Synced external references with 1.7 version
stevespringett Dec 2, 2025
2114c27
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 2, 2025
5f14c2a
Fixed property issue with component
stevespringett Dec 2, 2025
9f13aae
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 2, 2025
3a80369
Fixed composition model
stevespringett Dec 2, 2025
0d619e3
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 2, 2025
75c344d
Synced hash with v1.7 version
stevespringett Dec 2, 2025
8db8674
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 2, 2025
1c8bab8
Fixed copyright issue to align with how v1.7 does it.
stevespringett Dec 3, 2025
9c8c622
chore: update bundled schemas [skip ci]
github-actions[bot] Dec 3, 2025
6a39e36
Ported 1.7 unit tests to 2.0.
stevespringett Dec 4, 2025
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
37 changes: 37 additions & 0 deletions schema/2.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# CycloneDX 2.0 Schemas

This directory contains the official JSON Schema definitions for CycloneDX 2.0, as standardised in
[ECMA-424](https://ecma-international.org/publications-and-standards/standards/ecma-424/).
These schemas constitute the normative implementation of the CycloneDX specification and are intended for use in
validation, tooling, and data exchange.

## Schema Overview

| File | Description |
|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`cyclonedx-2.0.schema.json`](./cyclonedx-2.0.schema.json) | The normative schema for CycloneDX Bill of Materials (BOM) documents. This schema references modular models and defines the complete structure for expressing inventories and metadata. |
| [`cyclonedx-2.0-bundled.schema.json`](./cyclonedx-2.0-bundled.schema.json) | A fully resolved version of the BOM schema with all external model references inlined. Useful for systems that require a self-contained schema. |
| [`cyclonedx-api-2.0.schema.json`](./cyclonedx-api-2.0.schema.json) | The normative API-focused schema. It reuses CycloneDX models but is structured for compatibility with request/response patterns in service architectures. |
| [`cyclonedx-api-2.0-bundled.schema.json`](./cyclonedx-api-2.0-bundled.schema.json) | The combined version of the API schema with all model definitions embedded. Suitable for use in tools or validators that do not support `$ref` resolution. |

## Modularity and Model Composition

CycloneDX 2.0 is defined as a modular specification. All core concepts—such as components, services, vulnerabilities,
licensing, and AI/ML metadata, are encapsulated in reusable model definitions located in the [`model/`](./model) directory.

This modular architecture promotes:

- **Consistency** across multiple schema contexts
- **Reusability** of models within and beyond CycloneDX
- **Clarity and maintainability** for implementers

## Bundled Schemas

The `*-bundled` schema files are auto-generated from the normative schemas by resolving all references.
These are provided for convenience and do not supersede the authoritative pre-defined schemas.

## Related Resources

- CycloneDX Website: [https://cyclonedx.org](https://cyclonedx.org)
- ECMA-424 Publication: [https://ecma-international.org/publications-and-standards/standards/ecma-424/](https://ecma-international.org/publications-and-standards/standards/ecma-424/)
- Model Definitions: See [`model/README.md`](./model/README.md)
52 changes: 52 additions & 0 deletions schema/2.0/cyclonedx-2.0.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://localhost:8080/schema/2.0/cyclonedx-2.0.schema.json",
"type": "object",
"title": "CycloneDX Transparency Expression Language",
"$comment": "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
"required": [
"specFormat",
"specVersion"
],
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"specFormat": {
"type": "string",
"title": "Specification Format",
"description": "Specifies the format. This value must be \"CycloneDX\".",
"enum": [
"CycloneDX"
]
},
"specVersion": {
"type": "string",
"title": "Specification Version",
"description": "The version of the CycloneDX specification the BOM conforms to.",
"examples": [
"2.0"
]
},
"serialNumber": {
"type": "string",
"title": "BOM Serial Number",
"description": "Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number must conform to [RFC 4122](https://www.ietf.org/rfc/rfc4122.html). Use of serial numbers is recommended.",
"examples": [
"urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"
],
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"version": {
"type": "integer",
"title": "BOM Version",
"description": "Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.",
"minimum": 1,
"default": 1
}
},
"allOf": [
{ "$ref": "cyclonedx-common-2.0.schema.json#/$defs/extensibleProperties" }
]
}
10 changes: 10 additions & 0 deletions schema/2.0/cyclonedx-api-2.0.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://localhost:8080/schema/2.0/cyclonedx-api-2.0.schema.json",
"type": "object",
"title": "CycloneDX Transparency Expression Language: API",
"$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
"$defs": {

}
}
40 changes: 40 additions & 0 deletions schema/2.0/model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# CycloneDX 2.0 Model Definitions

This directory contains the modular JSON Schema definitions that constitute the building blocks of the CycloneDX 2.0 specification.

## Purpose

The model definitions are:

- **Reusable** across different schemas such as `bom.schema.json` and `api.schema.json`
- **Compositional**, enabling coherent and maintainable schema evolution
- **Portable**, supporting external reuse outside the CycloneDX context

Each file in this directory defines a discrete concept and adheres to the CycloneDX data modelling conventions.

These models are compiled into the schemas in the parent directory, ensuring consistency and maximising reuse.

| Schema File | Purpose |
|----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| [`cyclonedx-ai-model-parameters-2.0.schema.json`](./cyclonedx-ai-model-parameters-2.0.schema.json) | Defines configuration and metadata for AI/ML training, evaluation, and deployment parameters. |
| [`cyclonedx-ai-modelcard-2.0.schema.json`](./cyclonedx-ai-modelcard-2.0.schema.json) | Describes AI/ML model cards including intended use, limitations, and ethical considerations. |
| [`cyclonedx-annotation-2.0.schema.json`](./cyclonedx-annotation-2.0.schema.json) | Represents human or automated comments about BOM elements, such as components or services. |
| [`cyclonedx-common-2.0.schema.json`](./cyclonedx-common-2.0.schema.json) | Provides common types and base definitions used across all other schemas. |
| [`cyclonedx-component-2.0.schema.json`](./cyclonedx-component-2.0.schema.json) | Models hardware, software, data, cryptographic, and AI components and their attributes. |
| [`cyclonedx-composition-2.0.schema.json`](./cyclonedx-composition-2.0.schema.json) | Indicates the known and unknown completeness of BOM elements and their relationships. |
| [`cyclonedx-cryptography-2.0.schema.json`](./cyclonedx-cryptography-2.0.schema.json) | Defines cryptographic properties, including algorithms, keys, and post-quantum cryptographic readiness. |
| [`cyclonedx-declaration-2.0.schema.json`](./cyclonedx-declaration-2.0.schema.json) | Structures conformance declarations, claims, attestations, and associated evidence. |
| [`cyclonedx-definition-2.0.schema.json`](./cyclonedx-definition-2.0.schema.json) | Contains reusable definitions and enums referenced by other schemas. |
| [`cyclonedx-dependency-2.0.schema.json`](./cyclonedx-dependency-2.0.schema.json) | Captures dependency relationships among components and services in the BOM. |
| [`cyclonedx-formulation-2.0.schema.json`](./cyclonedx-formulation-2.0.schema.json) | Describes the process of manufacturing, building, or deploying a component or service. |
| [`cyclonedx-license-2.0.schema.json`](./cyclonedx-license-2.0.schema.json) | Models software licences using SPDX IDs, named licences, and optional full text. |
| [`cyclonedx-licensing-2.0.schema.json`](./cyclonedx-licensing-2.0.schema.json) | Expands on licence metadata with purchaser, licensee, terms, and validity periods. |
| [`cyclonedx-metadata-2.0.schema.json`](./cyclonedx-metadata-2.0.schema.json) | Contains metadata about the BOM, such as authorship, tools used, and timestamps. |
| [`cyclonedx-patent-2.0.schema.json`](./cyclonedx-patent-2.0.schema.json) | Represents patents relevant to components, including jurisdiction and legal status. |
| [`cyclonedx-patent-assertion-2.0.schema.json`](./cyclonedx-patent-assertion-2.0.schema.json) | Defines legal claims or disclaimers associated with patents. |
| [`cyclonedx-patent-family-2.0.schema.json`](./cyclonedx-patent-family-2.0.schema.json) | Groups related patents across different jurisdictions into patent families. |
| [`cyclonedx-release-notes-2.0.schema.json`](./cyclonedx-release-notes-2.0.schema.json) | Specifies structured release note content, including changes and version history. |
| [`cyclonedx-service-2.0.schema.json`](./cyclonedx-service-2.0.schema.json) | Models services such as APIs or microservices, including endpoints and interactions. |
| [`cyclonedx-standard-2.0.schema.json`](./cyclonedx-standard-2.0.schema.json) | Describes standards, regulations, and frameworks referenced in BOM declarations. |
| [`cyclonedx-vulnerability-2.0.schema.json`](./cyclonedx-vulnerability-2.0.schema.json) | Details vulnerabilities, including severity, remediation, and advisories. |

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://localhost:8080/schema/2.0/cyclonedx-ai-model-parameters-2.0.schema.json",
"type": "null",
"title": "CycloneDX Transparency Expression Language: AI Model Parameters",
"$comment": "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
"$defs": {
}
}
9 changes: 9 additions & 0 deletions schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://localhost:8080/schema/2.0/cyclonedx-ai-modelcard-2.0.schema.json",
"type": "null",
"title": "CycloneDX Transparency Expression Language: AI Model Card",
"$comment": "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
"$defs": {
}
}
9 changes: 9 additions & 0 deletions schema/2.0/model/cyclonedx-annotation-2.0.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "http://localhost:8080/schema/2.0/cyclonedx-annotation-2.0.schema.json",
"type": "null",
"title": "CycloneDX Transparency Expression Language: Annotation",
"$comment" : "CycloneDX JSON schema is published under the terms of the Apache License 2.0.",
"$defs": {
}
}
Loading
Loading