Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
2ab6b6b
docs: streamline descriptions - literals, references, code
jkowalleck Sep 8, 2026
6f6f532
docs: streamline descriptions - literals, references, code
jkowalleck Sep 8, 2026
dc2744a
fix
jkowalleck Sep 10, 2026
6535923
fix
jkowalleck Sep 10, 2026
f5b2e1f
fix
jkowalleck Sep 10, 2026
174ea95
fix
jkowalleck Sep 10, 2026
45e8608
fix
jkowalleck Sep 10, 2026
3996cd0
Merge branch '2.0-dev' into 2.0-dev_fix_descritions-literals-code
jkowalleck Sep 10, 2026
4549193
Merge remote-tracking branch 'origin/2.0-dev' into 2.0-dev_fix_descri…
jkowalleck Oct 5, 2026
569fc8a
Merge remote-tracking branch 'origin/2.0-dev' into 2.0-dev_fix_descri…
jkowalleck Nov 6, 2026
5d6c573
docs: streamline descriptions
jkowalleck Nov 9, 2026
a29f633
docs: streamline descriptions
jkowalleck Nov 9, 2026
b6ccf7f
update
jkowalleck Nov 9, 2026
bd372e0
update docs
jkowalleck Nov 9, 2026
35faa06
revert bundled
jkowalleck Nov 9, 2026
c8863d4
Merge remote-tracking branch 'origin/2.0-dev' into 2.0-dev_fix_descri…
jkowalleck Nov 10, 2026
9532006
docs
jkowalleck Nov 10, 2026
809269a
docs
jkowalleck Nov 10, 2026
f689c3c
docs
jkowalleck Nov 10, 2026
6951406
Merge remote-tracking branch 'origin/2.0-dev' into 2.0-dev_fix_descri…
jkowalleck Nov 11, 2026
2497bb4
docs
jkowalleck Nov 11, 2026
2e96e7b
examples
jkowalleck Nov 11, 2026
ecc40e5
remove "optional"
jkowalleck Nov 11, 2026
eec98ae
fix misplaced/duplicate docs
jkowalleck Nov 11, 2026
517a03f
examples
jkowalleck Nov 11, 2026
339498d
examples
jkowalleck Nov 11, 2026
fcde004
examples
jkowalleck Nov 11, 2026
42d99ee
examples
jkowalleck Nov 11, 2026
e9f8be2
fix
jkowalleck Nov 11, 2026
cf5db04
examples
jkowalleck Nov 11, 2026
7821ed7
docs
jkowalleck Nov 11, 2026
c08788e
docs
jkowalleck Nov 11, 2026
acdab8a
rolback
jkowalleck Nov 11, 2026
4de4a6e
docs
jkowalleck Nov 11, 2026
6a6af54
fix
jkowalleck Nov 12, 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
4 changes: 2 additions & 2 deletions schema/2.0/cyclonedx-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
},
"specFormat": {
"title": "Specification Format",
"description": "Specifies the format. This value shall be \"CycloneDX\".",
"description": "Specifies the format. This value shall be `\"CycloneDX\"`.",
"const": "CycloneDX"
},
"specVersion": {
Expand All @@ -40,7 +40,7 @@
"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'.",
"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
},
Expand Down
14 changes: 7 additions & 7 deletions schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"modelProperties": {
"type": "object",
"title": "AI/ML Model Properties",
"description": "Intrinsic technical characteristics of a machine learning model. This object should be specified for any component of type `machine-learning-model` and shall not be specified for other component types. Contextual and subjective aspects of a model, including ethical and fairness considerations, potential harms, groups at risk, and impact assessments, are expressed as risks. The `affects` property of each such risk references the model component and the parties that represent any groups at risk. Views of this data tailored to a specific audience, such as a model card, are expressed with perspectives.",
"description": "Intrinsic technical characteristics of a machine learning model. This object should be specified for any component with `type=\"machine-learning-model\"` and shall not be specified for other component types. Contextual and subjective aspects of a model, including ethical and fairness considerations, potential harms, groups at risk, and impact assessments, are expressed as risks. The `affects` property of each such risk references the model component and the parties that represent any groups at risk. Views of this data tailored to a specific audience, such as a model card, are expressed with perspectives.",
"additionalProperties": false,
"properties": {
"learningTypes": {
Expand Down Expand Up @@ -567,7 +567,7 @@
"bits": {
"type": "number",
"title": "Bits",
"description": "The nominal bit width per value. Fractional widths are permitted, for example 1.58 for ternary quantization.",
"description": "The nominal bit width per value. Fractional widths are permitted, for example `1.58` for ternary quantization.",
"exclusiveMinimum": 0,
"examples": [
8,
Expand Down Expand Up @@ -654,7 +654,7 @@
"groupSize": {
"type": "integer",
"title": "Group Size",
"description": "The number of elements sharing one scale and zero point when the granularity is `per-group`.",
"description": "The number of elements sharing one scale and zero point when `granularity=\"per-group\"`.",
"minimum": 1,
"examples": [
32,
Expand All @@ -665,7 +665,7 @@
"axis": {
"type": "integer",
"title": "Axis",
"description": "The tensor axis along which scales and zero points are assigned when the granularity is `per-channel` or `per-group`.",
"description": "The tensor axis along which scales and zero points are assigned when `granularity=\"per-channel\"` or `granularity=\"per-group\"`.",
"minimum": 0
}
}
Expand Down Expand Up @@ -727,7 +727,7 @@
"shape": {
"type": "array",
"title": "Shape",
"description": "The dimensional shape of the parameter, for example tensor dimensions. A dynamic dimension is expressed as null or -1.",
"description": "The dimensional shape of the parameter, for example tensor dimensions. A dynamic dimension is expressed as `null` or `-1`.",
"items": {
"oneOf": [
{
Expand Down Expand Up @@ -854,7 +854,7 @@
},
"datasetChoice": {
"title": "Dataset Choice",
"description": "A reference to a dataset documented as a component of type `data`, either within this BOM by `refId` or in another BOM by BOM-Link.",
"description": "A reference to a dataset documented as a component with `type=\"data\"`, either within this BOM by `refId` or in another BOM by BOM-Link.",
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/elementLink",
"examples": [
"training-dataset-1",
Expand Down Expand Up @@ -924,7 +924,7 @@
},
"measure": {
"title": "Measure",
"description": "The measured value of the performance metric with its unit. A dimensionless score uses the unit one, written as 1.",
"description": "The measured value of the performance metric with its unit. A dimensionless score uses the unit one, written as `\"1\"`.",
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/measure"
},
"slice": {
Expand Down
16 changes: 8 additions & 8 deletions schema/2.0/modules/cyclonedx-behavior-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
},
"kind": {
"title": "Kind",
"description": "An optional hint at the intent of the graph.",
"description": "A hint at the intent of the graph.",
"enum": [
"activity",
"state-machine",
Expand Down Expand Up @@ -261,7 +261,7 @@
],
"meta:enum": {
"activity": "An action that is performed, identified by a behavior, a behavior-instance reference, or a nested graph. The activity-flow counterpart of a step.",
"state": "A durable condition the subject rests in until a transition fires. The state-machine counterpart of a node. A composite state references its nested region through 'graph'.",
"state": "A durable condition the subject rests in until a transition fires. The state-machine counterpart of a node. A composite state references its nested region through `graph`.",
"event": "An intermediate event that occurs during the graph.",
"gateway": "A branch or merge point whose outgoing transitions carry the guards.",
"initial": "The starting point of the graph or of a composite node.",
Expand All @@ -282,22 +282,22 @@
"type": "integer",
"title": "Ordinal",
"minimum": 1,
"description": "Position within a sequential graph. Required when the graph ordering is 'sequential'. Ignored when transitions define the order."
"description": "Position within a sequential graph. Required when the containing graph has `ordering=\"sequential\"`. Ignored when transitions define the order."
},
"behavior": {
"$ref": "../../behavior-taxonomy.schema.json",
"title": "Behavior",
"description": "For an activity node, the behavior performed, drawn from the taxonomy. Mutually exclusive with 'ref' and 'graph'."
"description": "For an activity node, the behavior performed, drawn from the taxonomy. Mutually exclusive with `ref` and `graph`."
},
"ref": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType",
"title": "Behavior Reference",
"description": "For an activity node, a reference to a behavior instance. Mutually exclusive with 'behavior' and 'graph'."
"description": "For an activity node, a reference to a behavior instance. Mutually exclusive with `behavior` and `graph`."
},
"graph": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType",
"title": "Graph Reference",
"description": "A reference to a nested behavior graph. For an activity node it is the sub-process performed and is mutually exclusive with 'behavior' and 'ref'; for a composite node it is the nested region."
"description": "A reference to a nested behavior graph. For an activity node it is the sub-process performed and is mutually exclusive with `behavior` and `ref`; for a composite node it is the nested region."
},
"actors": {
"type": "array",
Expand All @@ -320,7 +320,7 @@
"eventType": {
"$ref": "#/$defs/trigger",
"title": "Event Type",
"description": "For an event node, the nature of the event, reusing the trigger vocabulary, such as signal, scheduled, or event-driven."
"description": "For an event node, the nature of the event, reusing the trigger vocabulary, such as `\"signal\"`, `\"scheduled\"`, or `\"event-driven\"`."
},
"gatewayKind": {
"title": "Gateway Kind",
Expand Down Expand Up @@ -415,7 +415,7 @@
"guard": {
"type": "string",
"title": "Guard",
"description": "A guard condition; the transition fires only when it evaluates to true."
"description": "A guard condition; the transition fires only when it evaluates to `true`."
},
"default": {
"type": "boolean",
Expand Down
22 changes: 12 additions & 10 deletions schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -282,11 +282,11 @@
"items": {
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice"
},
"description": "The parties that created the blueprint. Each entry is either an inline party object or a reference to a previously declared party. The party's `roles` should include `author`."
"description": "The parties that created the blueprint. Each entry is either an inline party object or a reference to a previously declared party. The party's `roles` should include `\"author\"`."
},
"reviewer": {
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice",
"description": "The party that reviewed the blueprint. The party's `roles` should include `reviewer`."
"description": "The party that reviewed the blueprint. The party's `roles` should include `\"reviewer\"`."
},
"reviewDate": {
"type": "string",
Expand All @@ -296,7 +296,7 @@
},
"approver": {
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice",
"description": "The party that approved the blueprint. The party's `roles` should include `signatory` or a custom role identifying the approving authority."
"description": "The party that approved the blueprint. The party's `roles` should include `\"signatory\"` or a custom role identifying the approving authority."
},
"approvalDate": {
"type": "string",
Expand Down Expand Up @@ -341,7 +341,8 @@
"type": "string",
"title": "Review Frequency",
"pattern": "^P(?!$)(\\d+Y)?(\\d+M)?(\\d+W)?(\\d+D)?$",
"description": "ISO 8601 duration for review frequency (e.g., P3M for quarterly)."
"description": "ISO 8601 duration for review frequency (e.g., `\"P3M\"` for quarterly).",
"examples": ["P1Y", "P3M", "P5W", "P23D"]
}
}
},
Expand Down Expand Up @@ -460,7 +461,7 @@
"tool"
],
"meta:enum": {
"actor": "An actor that is an asset in its own right, referencing a party via partyRef. A party such as a system or organization is commonly an asset, and a person may be an asset in the intelligence sense of a human source.",
"actor": "An actor that is an asset in its own right, referencing a party via `partyRef`. A party such as a system or organization is commonly an asset, and a person may be an asset in the intelligence sense of a human source.",
"agent": "Autonomous AI or software agent.",
"api": "API endpoint or interface.",
"broker": "Message broker or event bus infrastructure.",
Expand Down Expand Up @@ -860,7 +861,7 @@
"items": {
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice"
},
"description": "Parties that own the dataset. Each entry is either an inline party object or a reference to a previously declared party. The party's `roles` should include `owner`."
"description": "Parties that own the dataset. Each entry is either an inline party object or a reference to a previously declared party. The party's `roles` should include `\"owner\"`."
},
"authorization": {
"type": "array",
Expand Down Expand Up @@ -982,7 +983,8 @@
},
"dataFormat": {
"type": "string",
"description": "Data format (e.g., JSON, XML, Protocol Buffers)."
"description": "Data format.",
"examples": ["JSON", "XML", "Protocol Buffers"]
},
"authentication": {
"type": "array",
Expand Down Expand Up @@ -1117,7 +1119,7 @@
"boundary": {
"type": "object",
"title": "Boundary",
"description": "An edge that separates or connects two or more zones, marking a point where security controls, policies, or trust levels change. The controls expected when data or actors cross it are captured in crossingRequirements, and the threat model's trust boundary extends a boundary with trust semantics.",
"description": "An edge that separates or connects two or more zones, marking a point where security controls, policies, or trust levels change. The controls expected when data or actors cross it are captured in `crossingRequirements`, and the threat model's trust boundary extends a boundary with trust semantics.",
"required": [
"refId",
"zones"
Expand Down Expand Up @@ -1749,7 +1751,7 @@
},
"owner": {
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice",
"description": "The party responsible for tracking, validating, and maintaining this assumption over the lifecycle of the model. May be an inline party object or a reference to a previously declared party. The party's `roles` should include `owner`."
"description": "The party responsible for tracking, validating, and maintaining this assumption over the lifecycle of the model. May be an inline party object or a reference to a previously declared party. The party's `roles` should include `\"owner\"`."
},
"validationMethod": {
"type": "string",
Expand Down Expand Up @@ -2049,7 +2051,7 @@
"ownership": {
"type": "array",
"title": "Ownership",
"description": "Parties responsible for the asset. Each entry is either an inline party object or a reference to a previously declared party. The party's `roles` carry the relationship (`owner`, `steward`, `custodian`, `end-user`, or a custom role). Multiple parties may share the same role; preference among them is expressed via `role.order`.",
"description": "Parties responsible for the asset. Each entry is either an inline party object or a reference to a previously declared party. The party's `roles` carry the relationship (`\"owner\"`, `\"steward\"`, `\"custodian\"`, `\"end-user\"`, or a custom role). Multiple parties may share the same role; preference among them is expressed via `roles[].order`.",
"uniqueItems": true,
"items": {
"$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice"
Expand Down
4 changes: 2 additions & 2 deletions schema/2.0/modules/cyclonedx-certification-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"refId": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType",
"title": "Reference Identifier",
"description": "An optional identifier that can be used to reference the certification from elsewhere. Every `refId` shall be unique within the containing instance."
"description": "An identifier that can be used to reference the certification from elsewhere. Every `refId` shall be unique within the containing instance."
},
"standard": {
"type": "string",
Expand Down Expand Up @@ -61,7 +61,7 @@
"jurisdiction": {
"type": "string",
"title": "Jurisdiction",
"description": "ISO 3166-1 alpha-2 country code, ISO 3166-2 subdivision, or supranational identifier such as `EU`, where the certification applies.",
"description": "ISO 3166-1 alpha-2 country code, ISO 3166-2 subdivision, or supranational identifier such as `\"EU\"`, where the certification applies.",
"examples": [ "US", "EU", "GB", "AU", "US-CA" ]
},
"level": {
Expand Down
8 changes: 4 additions & 4 deletions schema/2.0/modules/cyclonedx-citation-2.0.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
},
"minItems": 1,
"title": "Field References",
"description": "One or more [JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901) identifying the JSON properties to which the attribution applies.\nExactly one of the \"pointers\" or \"expressions\" elements shall be present."
"description": "One or more [JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901) identifying the JSON properties to which the attribution applies.\nExactly one of the `pointers` or `expressions` elements shall be present."
},
"expressions": {
"type": "array",
Expand All @@ -42,7 +42,7 @@
},
"minItems": 1,
"title": "Path Expressions",
"description": "One or more path expressions used to locate values within a CycloneDX artifact or payload.\nExactly one of the \"pointers\" or \"expressions\" elements shall be present."
"description": "One or more path expressions used to locate values within a CycloneDX artifact or payload.\nExactly one of the `pointers` or `expressions` elements shall be present."
},
"timestamp": {
"type": "string",
Expand All @@ -53,12 +53,12 @@
"attributedTo": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType",
"title": "Attributed To",
"description": "The `refId` of an object, such as a component, service, tool, organisational entity, or person that supplied the cited information.\nAt least one of the \"attributedTo\" or \"process\" elements shall be present."
"description": "The `refId` of an object, such as a component, service, tool, organisational entity, or person that supplied the cited information.\nAt least one of the `attributedTo` or `process` elements shall be present."
},
"process": {
"$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType",
"title": "Process Reference",
"description": "The `refId` to a process (such as a formula, workflow, task, or step) defined in the `formulation` section that executed or generated the attributed data.\nAt least one of the \"attributedTo\" or \"process\" elements shall be present."
"description": "The `refId` to a process (such as a formula, workflow, task, or step) defined in the `formulation` section that executed or generated the attributed data.\nAt least one of the `attributedTo` or `process` elements shall be present."
},
"note": {
"type": "string",
Expand Down
Loading
Loading