From 2ab6b6b80add51dd1c1fded17a18510cb21bef13 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Tue, 8 Sep 2026 06:23:17 +0200 Subject: [PATCH 01/30] docs: streamline descriptions - literals, references, code --- .../cyclonedx-ai-modelcard-2.0.schema.json | 2 +- .../model/cyclonedx-behavior-2.0.schema.json | 10 ++-- .../model/cyclonedx-blueprint-2.0.schema.json | 14 +++--- .../cyclonedx-certification-2.0.schema.json | 2 +- .../model/cyclonedx-citation-2.0.schema.json | 8 +-- .../model/cyclonedx-common-2.0.schema.json | 14 +++--- .../model/cyclonedx-component-2.0.schema.json | 50 +++++++++---------- .../cyclonedx-composition-2.0.schema.json | 2 +- .../cyclonedx-cryptography-2.0.schema.json | 18 +++---- .../2.0/model/cyclonedx-data-2.0.schema.json | 4 +- .../model/cyclonedx-evidence-2.0.schema.json | 2 +- .../cyclonedx-formulation-2.0.schema.json | 6 +-- ...cyclonedx-jss_X590_2023_10-2.0.schema.json | 16 +++--- .../model/cyclonedx-license-2.0.schema.json | 6 +-- .../model/cyclonedx-metadata-2.0.schema.json | 6 +-- .../2.0/model/cyclonedx-party-2.0.schema.json | 14 +++--- .../model/cyclonedx-physical-2.0.schema.json | 4 +- .../cyclonedx-release-notes-2.0.schema.json | 4 +- .../2.0/model/cyclonedx-risk-2.0.schema.json | 12 ++--- .../model/cyclonedx-threat-2.0.schema.json | 2 +- .../model/cyclonedx-usecase-2.0.schema.json | 8 +-- .../cyclonedx-vulnerability-2.0.schema.json | 4 +- 22 files changed, 104 insertions(+), 104 deletions(-) diff --git a/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json b/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json index 5bb062879..da31dfe79 100644 --- a/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-ai-modelcard-2.0.schema.json @@ -9,7 +9,7 @@ "$comment": "Model card support in CycloneDX is derived from TensorFlow Model Card Toolkit released under the Apache 2.0 license and available from https://github.com/tensorflow/model-card-toolkit/blob/main/model_card_toolkit/schema/v0.0.2/model_card.schema.json. In addition, CycloneDX model card support includes portions of VerifyML, also released under the Apache 2.0 license and available from https://github.com/cylynx/verifyml/blob/main/verifyml/model_card_toolkit/schema/v0.0.4/model_card.schema.json.", "type": "object", "title": "Model Card", - "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types.", + "description": "A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component with `type=\"machine-learning-model\"` and must not be specified for other component types.", "additionalProperties": false, "properties": { "bom-ref": { diff --git a/schema/2.0/model/cyclonedx-behavior-2.0.schema.json b/schema/2.0/model/cyclonedx-behavior-2.0.schema.json index ca2b5ca24..25a7f1940 100644 --- a/schema/2.0/model/cyclonedx-behavior-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-behavior-2.0.schema.json @@ -266,7 +266,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.", @@ -287,22 +287,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 graph's `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", diff --git a/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json b/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json index 28a4937b0..363a8c338 100644 --- a/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json @@ -283,11 +283,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", @@ -297,7 +297,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", @@ -410,7 +410,7 @@ }, "componentRef": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", - "description": "Reference using bom-link or bom-ref to the component this asset represents, including components of type `service`." + "description": "Reference using bom-link or bom-ref to the component this asset represents, including components of type `\"service\"`." }, "partyRef": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", @@ -844,7 +844,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", @@ -1727,7 +1727,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", @@ -1943,7 +1943,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 `role.order`.", "uniqueItems": true, "items": { "$ref": "cyclonedx-party-2.0.schema.json#/$defs/partyChoice" diff --git a/schema/2.0/model/cyclonedx-certification-2.0.schema.json b/schema/2.0/model/cyclonedx-certification-2.0.schema.json index 05c08f0e8..fcd2a179d 100644 --- a/schema/2.0/model/cyclonedx-certification-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-certification-2.0.schema.json @@ -60,7 +60,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": { diff --git a/schema/2.0/model/cyclonedx-citation-2.0.schema.json b/schema/2.0/model/cyclonedx-citation-2.0.schema.json index f917370c4..7ea40c9a2 100644 --- a/schema/2.0/model/cyclonedx-citation-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-citation-2.0.schema.json @@ -31,7 +31,7 @@ }, "minItems": 1, "title": "Field References", - "description": "One or more [JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901) identifying the BOM fields to which the attribution applies.\nExactly one of the \"pointers\" or \"expressions\" elements must be present." + "description": "One or more [JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901) identifying the BOM fields to which the attribution applies.\nExactly one of the `pointers` or `expressions` elements must be present." }, "expressions": { "type": "array", @@ -42,7 +42,7 @@ }, "minItems": 1, "title": "Path Expressions", - "description": "One or more path expressions used to locate values within a BOM.\nExactly one of the \"pointers\" or \"expressions\" elements must be present." + "description": "One or more path expressions used to locate values within a BOM.\nExactly one of the `pointers` or `expressions` elements must be present." }, "timestamp": { "type": "string", @@ -53,12 +53,12 @@ "attributedTo": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", "title": "Attributed To", - "description": "The `bom-ref` 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 must be present." + "description": "The `bom-ref` 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 must be present." }, "process": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", "title": "Process Reference", - "description": "The `bom-ref` 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 must be present." + "description": "The `bom-ref` 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 must be present." }, "note": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-common-2.0.schema.json b/schema/2.0/model/cyclonedx-common-2.0.schema.json index 6e53d544b..cd3c75952 100644 --- a/schema/2.0/model/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-common-2.0.schema.json @@ -259,7 +259,7 @@ "support": "Community or commercial support", "source-distribution": "The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type.", "distribution": "Direct or repository download location", - "distribution-intake": "The location where a component was published to. This is often the same as \"distribution\" but may also include specialized publishing processes that act as an intermediary.", + "distribution-intake": "The location where a component was published to. This is often the same as `\"distribution\"` but may also include specialized publishing processes that act as an intermediary.", "license": "The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness.", "build-meta": "Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)", "build-system": "Reference to an automated build system", @@ -285,7 +285,7 @@ "certification-report": "Industry, regulatory, or other certification from an accredited (if applicable) certification body.", "codified-infrastructure": "Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC).", "quality-metrics": "Report or system in which quality metrics can be obtained.", - "poam": "Plans of Action and Milestones (POA&M) complement an \"attestation\" external reference. POA&M is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".", + "poam": "Plans of Action and Milestones (POA&M) complement an `\"attestation\"` external reference. POA&M is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".", "perspective": "A CycloneDX perspective defines a domain-specific view, enabling different audiences to interpret and navigate the data through their own conceptual lens.", "electronic-signature": "An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name.", "digital-signature": "A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.", @@ -294,7 +294,7 @@ "patent-family": "References information about a patent family which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. A patent family is a group of related patent applications or granted patents that cover the same or similar invention. For detailed patent family information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as [ST.96](https://www.wipo.int/standards/en/st96).", "patent-assertion" : "References assertions made regarding patents associated with a component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents.", "citation": "A reference to external citations applicable to the object identified by this BOM entry or the BOM itself. When used with a BOM-Link, this allows offloading citations into a separate CycloneDX BOM.", - "swid-tag": "A Software Identification (SWID) tag document conforming to ISO/IEC 19770-2. The reference resolves to the XML SoftwareIdentity document itself, including all of its metadata (entities, evidence, payload, links, and meta elements). This is distinct from the `swid` identifier scheme, which carries only the tagId of a SWID tag.", + "swid-tag": "A Software Identification (SWID) tag document conforming to ISO/IEC 19770-2. The reference resolves to the XML SoftwareIdentity document itself, including all of its metadata (entities, evidence, payload, links, and meta elements). This is distinct from the \"swid\" identifier scheme, which carries only the tagId of a SWID tag.", "gs1-digital-link": "A [GS1 Digital Link URI](https://ref.gs1.org/standards/digital-link/uri-syntax/) that connects the component's GS1 identification key, such as a GTIN, to online sources of information, including product data, safety documentation, digital product passports, and recall status. The URI may include key qualifiers, such as a batch or serial number, enabling identification at the class, batch, or individual item level. Component identity shall be derived from the component's identifiers, not from keys embedded in this URI.", "other": "Use this if no other types accurately describe the purpose of the external reference." } @@ -547,7 +547,7 @@ "isoCode": { "type": "string", "title": "ISO Code", - "description": "The country or subdivision of origin, expressed as an ISO 3166-1 alpha-2 country code (for example, 'CA' for Canada) or an ISO 3166-2 subdivision code (for example, 'US-CA' for California, United States).", + "description": "The country or subdivision of origin, expressed as an ISO 3166-1 alpha-2 country code (for example, 'CA' for Canada) or an ISO 3166-2 subdivision code (for example, `\"US-CA\"` for California, United States).", "pattern": "^[A-Z]{2}(-[A-Z0-9]{1,3})?$", "examples": [ "CA", "US-CA" ] }, @@ -597,7 +597,7 @@ "extensibleProperties": { "type": "object", "title": "Extensible Properties", - "$comment": "This is a mixin. It intentionally does NOT restrict additional/unevaluated properties itself; schemas composing it via `allOf` are expected to close themselves with `unevaluatedProperties: false` so that both their own defined properties and these patternProperties remain usable.", + "$comment": "This is a mixin. It intentionally does NOT restrict additional/unevaluated properties itself; schemas composing it via `allOf` are expected to close themselves with `unevaluatedProperties=false` so that both their own defined properties and these patternProperties remain usable.", "patternProperties": { "^ext:[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}:.+$": { "description": "CycloneDX supports a structured and namespace-aware mechanism for extensibility through the use of extensible properties. This mechanism enables organizations, ecosystems, and tool vendors to safely introduce custom properties without conflicting with the core schema or other extensions.\n\nExtensible properties are defined as a JSON object whose keys must conform to a strict pattern that resembles a reverse domain name structure, prefixed with ext:. This pattern provides a namespacing convention that aligns with well-established practices in other structured formats (e.g., XML namespaces).\n\nValues that are objects must declare the schema they conform to via `$schema`. This requirement applies recursively to objects contained in arrays, at any nesting depth.", @@ -650,7 +650,7 @@ "baseObject": { "type": "object", "description": "Base object for all CycloneDX entities. Automatically includes support for extensible properties.", - "$comment": "This is a mixin. It intentionally does NOT set `unevaluatedProperties: false` — that keyword cannot see properties defined by schemas composing this one via `allOf`, and would reject them. Concrete (leaf) schemas composing this mixin must close themselves with `unevaluatedProperties: false`.", + "$comment": "This is a mixin. It intentionally does NOT set `unevaluatedProperties=false` — that keyword cannot see properties defined by schemas composing this one via `allOf`, and would reject them. Concrete (leaf) schemas composing this mixin must close themselves with `unevaluatedProperties=false`.", "allOf": [ { "$ref": "#/$defs/extensibleProperties" } ], @@ -668,7 +668,7 @@ "format": "date-time", "title": "Timestamp", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$", - "description": "An RFC 3339-compliant UTC timestamp using Zulu time (i.e., ending with 'Z'). The format must be 'YYYY-MM-DDTHH:MM:SSZ' or include optional fractional seconds, e.g., 'YYYY-MM-DDTHH:MM:SS.sssZ'. Offsets such as '+00:00' are not allowed." + "description": "An RFC 3339-compliant UTC timestamp using Zulu time (i.e., ending with `\"Z\"`). The format must be `YYYY-MM-DDTHH:MM:SSZ` or include optional fractional seconds, e.g., `YYYY-MM-DDTHH:MM:SS.sssZ`. Offsets such as `\"+00:00\"` are not allowed." }, "ordinalVersion": { "title": "Ordinal Version", diff --git a/schema/2.0/model/cyclonedx-component-2.0.schema.json b/schema/2.0/model/cyclonedx-component-2.0.schema.json index af1b29efd..1a14cc6d0 100644 --- a/schema/2.0/model/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-component-2.0.schema.json @@ -46,14 +46,14 @@ "container": "A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization).", "platform": "A runtime environment that interprets or executes software. This may include runtimes such as those that execute bytecode, just-in-time compilers, interpreters, or low-code/no-code application platforms.", "operating-system": "A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system).", - "device": "A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).", + "device": "A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of `type=\"firmware\"` or `type=\"operating-system\"` (whichever is relevant), describing information about the software running on the device. See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).", "device-driver": "A special type of software that operates or controls a particular type of device. Refer to [https://en.wikipedia.org/wiki/Device_driver](https://en.wikipedia.org/wiki/Device_driver).", "firmware": "A special type of software that provides low-level control over a device's hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware).", "file": "A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.", "machine-learning-model": "A model based on training data that can make predictions or decisions without being explicitly programmed to do so.", "data": "A collection of discrete values that convey information.", "cryptographic-asset": "A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets.", - "material": "A physical substance in raw or processed form that is used to make, maintain, or repair an item, such as a metal, alloy, polymer, chemical, or other matter. Materials are commonly tracked for sourcing, provenance, and regulatory compliance. A finished physical item should be classified as 'device' instead.", + "material": "A physical substance in raw or processed form that is used to make, maintain, or repair an item, such as a metal, alloy, polymer, chemical, or other matter. Materials are commonly tracked for sourcing, provenance, and regulatory compliance. A finished physical item should be classified as 'type=\"device\"` instead.", "service": "A service, including microservices, function-as-a-service, and other types of network or intra-process services. Service-specific attributes, endpoints and the data profiles characterizing the data the service handles, apply exclusively to this component type." }, "title": "Component Type", @@ -97,17 +97,17 @@ "version": { "$ref": "#/$defs/version", "title": "Component Version", - "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.\nMust be used exclusively, either 'version' or 'versionRange', but not both." + "description": "The component version. The version should ideally comply with semantic versioning but is not enforced.\nMust be used exclusively, either `version` or `versionRange`, but not both." }, "versionRange": { "$ref": "#/$defs/versionRange", "title": "Component Version Range", - "description": "For an external component, this specifies the accepted version range.\nThe value must adhere to the Package URL Version Range syntax (vers), as defined at Date: Tue, 8 Sep 2026 07:44:12 +0200 Subject: [PATCH 02/30] docs: streamline descriptions - literals, references, code Signed-off-by: Jan Kowalleck --- schema/2.0/cyclonedx-2.0.schema.json | 6 +++--- .../model/cyclonedx-blueprint-2.0.schema.json | 4 ++-- .../2.0/model/cyclonedx-common-2.0.schema.json | 6 +++--- .../model/cyclonedx-component-2.0.schema.json | 10 +++++----- .../2.0/model/cyclonedx-control-2.0.schema.json | 2 +- .../model/cyclonedx-cryptography-2.0.schema.json | 6 +++--- schema/2.0/model/cyclonedx-data-2.0.schema.json | 2 +- .../model/cyclonedx-declaration-2.0.schema.json | 4 ++-- .../2.0/model/cyclonedx-evidence-2.0.schema.json | 2 +- .../cyclonedx-jss_X590_2023_10-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-party-2.0.schema.json | 2 +- .../2.0/model/cyclonedx-patent-2.0.schema.json | 2 +- .../model/cyclonedx-perspective-2.0.schema.json | 2 +- .../2.0/model/cyclonedx-physical-2.0.schema.json | 2 +- .../model/cyclonedx-requirement-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-risk-2.0.schema.json | 16 ++++++++-------- .../2.0/model/cyclonedx-usecase-2.0.schema.json | 2 +- .../cyclonedx-vulnerability-2.0.schema.json | 2 +- 18 files changed, 37 insertions(+), 37 deletions(-) diff --git a/schema/2.0/cyclonedx-2.0.schema.json b/schema/2.0/cyclonedx-2.0.schema.json index 8e7573861..79de8140f 100644 --- a/schema/2.0/cyclonedx-2.0.schema.json +++ b/schema/2.0/cyclonedx-2.0.schema.json @@ -18,7 +18,7 @@ "specFormat": { "type": "string", "title": "Specification Format", - "description": "Specifies the format. This value shall be \"CycloneDX\".", + "description": "Specifies the format. This value shall be `\"CycloneDX\"`.", "enum": [ "CycloneDX" ] @@ -43,7 +43,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 }, @@ -52,7 +52,7 @@ }, "components": { "$ref": "model/cyclonedx-component-2.0.schema.json#/$defs/components", - "description": "A collection of components. When a metadata component is present, this array represents the inventory of components associated with that subject, forming a bill of materials. When the metadata component is omitted, the array provides component data for interchange purposes without establishing a compositional relationship." + "description": "A collection of components. When a metadata component is present, this array represents the inventory of components associated with that subject, forming a bill of materials. When the `metadata.component` is omitted, the array provides component data for interchange purposes without establishing a compositional relationship." }, "dependencies": { "$ref": "model/cyclonedx-dependency-2.0.schema.json#/$defs/dependencies" diff --git a/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json b/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json index 363a8c338..62c99dfc9 100644 --- a/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json @@ -338,7 +338,7 @@ "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)." } } }, @@ -967,7 +967,7 @@ }, "dataFormat": { "type": "string", - "description": "Data format (e.g., JSON, XML, Protocol Buffers)." + "description": "Data format (e.g., `\"JSON\"`, `\"XML\"`, `\"Protocol Buffers\"`)." }, "authentication": { "type": "array", diff --git a/schema/2.0/model/cyclonedx-common-2.0.schema.json b/schema/2.0/model/cyclonedx-common-2.0.schema.json index cd3c75952..e8acf76a3 100644 --- a/schema/2.0/model/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-common-2.0.schema.json @@ -531,7 +531,7 @@ "distribution": { "type": "array", "title": "Origin Distribution", - "description": "The distribution of the origin across regions. The percentages of all entries shall total 100, within rounding of the stated precision.", + "description": "The distribution of the origin across regions. The percentages of all entries shall total `100`, within rounding of the stated precision.", "minItems": 1, "items": { "$ref": "#/$defs/originRegion" } } @@ -554,7 +554,7 @@ "percentage": { "type": "number", "title": "Percentage", - "description": "The percentage of the whole attributable to this region. The percentages of all entries in a distribution must total 100, within rounding of the stated precision.", + "description": "The percentage of the whole attributable to this region. The percentages of all entries in a distribution must total `100`, within rounding of the stated precision.", "minimum": 0, "maximum": 100 }, @@ -959,7 +959,7 @@ "type": "string", "pattern": "^([a-z]{2})(-[A-Z]{2})?$", "title": "Locale", - "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code must be lower case. If the country code is specified, the country code must be upper case. The language code and country code must be separated by a minus sign. Examples: en, en-US, fr, fr-CA" + "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code must be lower case. If the country code is specified, the country code must be upper case. The language code and country code must be separated by a minus sign. Examples: `\"en\"`, `\"en-US\"`, `\"fr\"`, `\"fr-CA\"`." }, "signatures": { "$ref": "cyclonedx-jss_X590_2023_10-2.0.schema.json#/$defs/signatures", diff --git a/schema/2.0/model/cyclonedx-component-2.0.schema.json b/schema/2.0/model/cyclonedx-component-2.0.schema.json index 1a14cc6d0..1ffb6bef3 100644 --- a/schema/2.0/model/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-component-2.0.schema.json @@ -91,7 +91,7 @@ "name": { "type": "string", "title": "Component Name", - "description": "The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery", + "description": "The name of the component. This will often be a shortened, single name of the component. Examples: `\"commons-lang3\"` and `\"jquery\"`.", "examples": ["tomcat-catalina"] }, "version": { @@ -207,7 +207,7 @@ "items": {"$ref": "#/$defs/componentOrChoice"}, "uniqueItems": true, "title": "Components", - "description": "A list of components included in the parent component, including software, hardware, and services. Entries may be concrete components or component-choice wrappers expressing conditional or alternate relationships. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains." + "description": "A list of components included in the parent component, including software, hardware, and services. Entries may be concrete components or component-choice wrappers expressing conditional or alternate relationships. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains." }, "evidence": { "$ref": "#/$defs/componentEvidence", @@ -562,7 +562,7 @@ "minimum": 0, "maximum": 1, "title": "Confidence", - "description": "The overall confidence of the detection from 0 to 1, where 1 is 100% confidence." + "description": "The overall confidence of the detection from `0` to `1`, where `1` is 100% confidence." }, "methods": { "type": "array", @@ -622,7 +622,7 @@ "minimum": 0, "maximum": 1, "title": "Confidence", - "description": "The overall confidence of the detection from 0 to 1, where 1 is 100% confidence." + "description": "The overall confidence of the detection from `0` to `1`, where `1` is 100% confidence." }, "methods": { "type": "array", @@ -675,7 +675,7 @@ "minimum": 0, "maximum": 1, "title": "Confidence", - "description": "The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence." + "description": "The overall confidence of the evidence from `0` to `1`, where `1` is 100% confidence." }, "concludedValue": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-control-2.0.schema.json b/schema/2.0/model/cyclonedx-control-2.0.schema.json index e7762a1e7..e6c8fe0b3 100644 --- a/schema/2.0/model/cyclonedx-control-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-control-2.0.schema.json @@ -202,7 +202,7 @@ "minimum": 0, "maximum": 1, "title": "Percentage", - "description": "Effectiveness as a decimal from 0 to 1." + "description": "Effectiveness as a decimal from `0` to `1`." }, "rating": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json b/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json index 0617b4d1e..6640a7afc 100644 --- a/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json @@ -40,7 +40,7 @@ "primitive": { "type": "string", "title": "primitive", - "description": "Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms (combiner, e.g. SP800-56Cr2).", + "description": "Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (`\"drbg\"`, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (`\"mac\"`, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (`\"pke`\", e.g. RSA), extended output functions (`\"xof\"`, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (`\"ae\"`, e.g. AES-GCM) and the combination of multiple algorithms (`\"combiner\"`, e.g. SP800-56Cr2).", "enum": [ "drbg", "mac", @@ -91,7 +91,7 @@ "parameterSetIdentifier": { "type": "string", "title": "Parameter Set Identifier", - "description": "An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, `128` identifies the key length in bits, in SHA256, `256` identifies the digest length, `128` in SHAKE128 identifies its maximum security level in bits, and `\"SHA2-128s\"` identifies a parameter set used in SLH-DSA (FIPS205)." + "description": "An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, `\"128\"` identifies the key length in bits, in SHA256, `\"256\"` identifies the digest length, `\"128\"` in SHAKE128 identifies its maximum security level in bits, and `\"SHA2-128s\"` identifies a parameter set used in SLH-DSA (FIPS205)." }, "ellipticCurve": { "$ref": "../../cryptography-defs.schema.json#/definitions/ellipticCurvesEnum", @@ -722,7 +722,7 @@ "format": { "type": "string", "title": "Format", - "description": "The format of the related cryptographic material (e.g. P8, PEM, DER)." + "description": "The format of the related cryptographic material (e.g. `\"P8\"`, `\"PEM\"`, `\"DER\"`)." }, "securedBy": { "$ref": "#/$defs/securedBy", diff --git a/schema/2.0/model/cyclonedx-data-2.0.schema.json b/schema/2.0/model/cyclonedx-data-2.0.schema.json index 226940793..e8560f12e 100644 --- a/schema/2.0/model/cyclonedx-data-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-data-2.0.schema.json @@ -337,7 +337,7 @@ "format": { "type": "object", "title": "Format", - "description": "The serialisation or encoding format of this object, such as application/json, text/csv, or application/hl7-v2.", + "description": "The serialisation or encoding format of this object, such as `\"application/json\"`, `\"text/csv\"`, or `\"application/hl7-v2\"`.", "additionalProperties": false, "properties": { "url": { diff --git a/schema/2.0/model/cyclonedx-declaration-2.0.schema.json b/schema/2.0/model/cyclonedx-declaration-2.0.schema.json index 951e5a807..4e3e998e7 100644 --- a/schema/2.0/model/cyclonedx-declaration-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-declaration-2.0.schema.json @@ -95,7 +95,7 @@ "minimum": 0, "maximum": 1, "title": "Score", - "description": "The conformance of the claim between and inclusive of 0 and 1, where 1 is 100% conformance." + "description": "The conformance of the claim between and inclusive of `0` and `1`, where `1` is 100% conformance." }, "rationale": { "type": "string", @@ -121,7 +121,7 @@ "minimum": 0, "maximum": 1, "title": "Score", - "description": "The confidence of the claim between and inclusive of 0 and 1, where 1 is 100% confidence." + "description": "The confidence of the claim between and inclusive of `0` and `1`, where `1` is 100% confidence." }, "rationale": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-evidence-2.0.schema.json b/schema/2.0/model/cyclonedx-evidence-2.0.schema.json index 53a898f13..46a89bda0 100644 --- a/schema/2.0/model/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-evidence-2.0.schema.json @@ -179,7 +179,7 @@ "minimum": 0, "maximum": 1, "title": "Confidence", - "description": "The confidence of the evidence from 0 to 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence." + "description": "The confidence of the evidence from `0` to `1`, where `1` is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence." }, "value": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-jss_X590_2023_10-2.0.schema.json b/schema/2.0/model/cyclonedx-jss_X590_2023_10-2.0.schema.json index 24f65761c..24b23322f 100644 --- a/schema/2.0/model/cyclonedx-jss_X590_2023_10-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-jss_X590_2023_10-2.0.schema.json @@ -44,7 +44,7 @@ }, "hashAlgorithm": { "title": "Hash Algorithm", - "description": "This property identifies the hashing algorithm, as defined by the Internet Assigned Numbers Authority (IANA)…, that was used to hash the JCS version of the full JSON object (JSON Object + JSS Signature) and is a case-sensitive ASCII string. Implementations MAY use any current and widely accepted hashing algorithm (e.g., sha-256, sha-512) that is defined in the IANA registry. The actual signing process, defined in the algorithm property, sometimes uses an internal hashing algorithm inside the signing process itself, this property MAY identify the same hashing algorithm as the signing process or MAY identify a different hashing algorithm.", + "description": "This property identifies the hashing algorithm, as defined by the Internet Assigned Numbers Authority (IANA)…, that was used to hash the JCS version of the full JSON object (JSON Object + JSS Signature) and is a case-sensitive ASCII string. Implementations MAY use any current and widely accepted hashing algorithm (e.g., `\"sha-256\"`, `\"sha-512\"`) that is defined in the IANA registry. The actual signing process, defined in the algorithm property, sometimes uses an internal hashing algorithm inside the signing process itself, this property MAY identify the same hashing algorithm as the signing process or MAY identify a different hashing algorithm.", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "string", "pattern": "^[a-z0-9-]+$", diff --git a/schema/2.0/model/cyclonedx-party-2.0.schema.json b/schema/2.0/model/cyclonedx-party-2.0.schema.json index d756269de..ab7d29d7f 100644 --- a/schema/2.0/model/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-party-2.0.schema.json @@ -72,7 +72,7 @@ "parties": { "type": "array", "title": "Parties", - "description": "Parties associated with the subject. Each item identifies an organization, individual, system, or abstract archetype playing one or more named roles such as manufacturer, supplier, author, integrator, quality-control, or any custom role. The same party can hold multiple roles, each independently ranked via `role.order` to express preference (for example, primary supplier with order 1 and alternate supplier with order 2). Items may be inline party objects or references to parties declared elsewhere.", + "description": "Parties associated with the subject. Each item identifies an organization, individual, system, or abstract archetype playing one or more named roles such as manufacturer, supplier, author, integrator, quality-control, or any custom role. The same party can hold multiple roles, each independently ranked via `role.order` to express preference (for example, primary supplier with order `1` and alternate supplier with order `2`). Items may be inline party objects or references to parties declared elsewhere.", "items": { "$ref": "#/$defs/partyChoice" } }, "partyChoice": { diff --git a/schema/2.0/model/cyclonedx-patent-2.0.schema.json b/schema/2.0/model/cyclonedx-patent-2.0.schema.json index a97180786..071b982db 100644 --- a/schema/2.0/model/cyclonedx-patent-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-patent-2.0.schema.json @@ -48,7 +48,7 @@ "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9\\-/.()\\s]{0,28}[A-Za-z0-9]$", "title": "Patent Publication Number", - "description": "This is the number assigned to a patent application once it is published. Patent applications are generally published 18 months after filing (unless an applicant requests non-publication). This number is distinct from the application number. \n\nPurpose: Identifies the publicly available version of the application. \n\nFormat: Varies by jurisdiction, often similar to application numbers but includes an additional suffix indicating publication. \n\nExample:\n - US: US20240000123A1 (indicates the first publication of application US20240000123) \n - Europe: EP23123456A1 (first publication of European application EP23123456). \n\nWIPO ST.96 v8.0: \n - Publication Number field: https://www.wipo.int/standards/XMLSchema/ST96/V8_0/Patent/PublicationNumber.xsd" + "description": "This is the number assigned to a patent application once it is published. Patent applications are generally published 18 months after filing (unless an applicant requests non-publication). This number is distinct from the application number. \n\nPurpose: Identifies the publicly available version of the application. \n\nFormat: Varies by jurisdiction, often similar to application numbers but includes an additional suffix indicating publication. \n\nExample:\n - US: `\"US20240000123A1\"` (indicates the first publication of application US20240000123) \n - Europe: `\"EP23123456A1\"` (first publication of European application EP23123456). \n\nWIPO ST.96 v8.0: \n - Publication Number field: https://www.wipo.int/standards/XMLSchema/ST96/V8_0/Patent/PublicationNumber.xsd" }, "title": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-perspective-2.0.schema.json b/schema/2.0/model/cyclonedx-perspective-2.0.schema.json index 217cf5870..207370a4f 100644 --- a/schema/2.0/model/cyclonedx-perspective-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-perspective-2.0.schema.json @@ -108,7 +108,7 @@ "weight": { "type": "number", "title": "Weight", - "description": "Describes the importance of a field in relation to other fields. Values shall be between 0.0 and 1.0. This allows for relative ranking of mappings, where higher values indicate greater importance.", + "description": "Describes the importance of a field in relation to other fields. Values shall be between `0.0` and `1.0`. This allows for relative ranking of mappings, where higher values indicate greater importance.", "minimum": 0.0, "maximum": 1.0 }, diff --git a/schema/2.0/model/cyclonedx-physical-2.0.schema.json b/schema/2.0/model/cyclonedx-physical-2.0.schema.json index 7d489ab8e..6aff226b4 100644 --- a/schema/2.0/model/cyclonedx-physical-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-physical-2.0.schema.json @@ -79,7 +79,7 @@ "uniqueItems": true, "minItems": 1, "title": "Designators", - "description": "Reference designators identifying the placement on the assembly, such as U5, R12, C3.", + "description": "Reference designators identifying the placement on the assembly, such as `\"U5\"`, `\"R12\"`, `\"C3`\".", "examples": [ [ "U5" ], [ "C3", "C4", "C9", "C11", "C14", "C15" ] ] }, "layer": { diff --git a/schema/2.0/model/cyclonedx-requirement-2.0.schema.json b/schema/2.0/model/cyclonedx-requirement-2.0.schema.json index d141b1b67..c3ff0f1e7 100644 --- a/schema/2.0/model/cyclonedx-requirement-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-requirement-2.0.schema.json @@ -29,7 +29,7 @@ "id": { "type": "string", "title": "Identifier", - "description": "A unique identifier for the requirement, often used in requirement management systems (e.g., REQ-001)." + "description": "A unique identifier for the requirement, often used in requirement management systems (e.g., `\"REQ-001\"`)." }, "name": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-risk-2.0.schema.json b/schema/2.0/model/cyclonedx-risk-2.0.schema.json index d78e90ca0..fd17c3ab1 100644 --- a/schema/2.0/model/cyclonedx-risk-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-risk-2.0.schema.json @@ -406,7 +406,7 @@ "minimum": 0, "maximum": 1, "title": "Confidence", - "description": "Confidence in this rating, expressed as a decimal from 0 to 1, where 1 is full confidence. Supports quantitative methods that reason over uncertainty." + "description": "Confidence in this rating, expressed as a decimal from `0` to `1`, where `1` is full confidence. Supports quantitative methods that reason over uncertainty." }, "rationale": { "type": "string", @@ -452,13 +452,13 @@ "type": "number", "minimum": 0, "maximum": 1, - "description": "Probability as a decimal from 0 to 1." + "description": "Probability as a decimal from `0` to `1`." }, "frequency": { "type": "number", "minimum": 0, "title": "Frequency", - "description": "The expected number of events within the timeframe, for frequency-based methods such as the [FAIR](https://www.fairinstitute.org/) loss event frequency. Unlike a probability, a frequency may exceed 1." + "description": "The expected number of events within the timeframe, for frequency-based methods such as the [FAIR](https://www.fairinstitute.org/) loss event frequency. Unlike a probability, a frequency may exceed `1`." }, "timeframe": { "type": "string", @@ -589,7 +589,7 @@ "weight": { "type": "number", "title": "Weight", - "description": "The relative importance or weight of this factor in the overall likelihood calculation, expressed as a decimal between 0 and 1. When multiple factors are present, weights can be used to produce a weighted average likelihood score. A weight of 1 indicates full importance; a weight of 0 indicates no importance.", + "description": "The relative importance or weight of this factor in the overall likelihood calculation, expressed as a decimal between `0` and `1`. When multiple factors are present, weights can be used to produce a weighted average likelihood score. A weight of `1` indicates full importance; a weight of `0` indicates no importance.", "minimum": 0, "maximum": 1 }, @@ -785,7 +785,7 @@ "minimum": 0, "maximum": 1, "title": "Weight", - "description": "The relative importance of this factor in the overall impact calculation, expressed as a decimal from 0 to 1. OCTAVE Allegro, for example, ranks impact areas and multiplies the ranking by the factor value." + "description": "The relative importance of this factor in the overall impact calculation, expressed as a decimal from `0` to `1`. OCTAVE Allegro, for example, ranks impact areas and multiplies the ranking by the factor value." }, "description": { "type": "string", @@ -912,13 +912,13 @@ "qualitative-matrix" ], "meta:enum": { - "dread": "[DREAD](https://en.wikipedia.org/wiki/DREAD_%28risk_assessment_model%29) risk rating model, the average of five ratings (damage, reproducibility, exploitability, affected users, discoverability) each scored 1 to 10.", + "dread": "[DREAD](https://en.wikipedia.org/wiki/DREAD_%28risk_assessment_model%29) risk rating model, the average of five ratings (damage, reproducibility, exploitability, affected users, discoverability) each scored `1` to `10`.", "fair": "[Factor Analysis of Information Risk (FAIR)](https://www.fairinstitute.org/), a quantitative methodology expressing risk as loss event frequency multiplied by loss magnitude.", "fmea": "[Failure Mode and Effects Analysis (FMEA)](https://asq.org/quality-resources/fmea), using a risk priority number of severity multiplied by occurrence multiplied by detection.", "nist-sp-800-30": "[NIST SP 800-30](https://csrc.nist.gov/pubs/sp/800/30/r1/final) guide for conducting risk assessments, using its exemplary likelihood and impact scales.", "octave": "[OCTAVE Allegro](https://www.sei.cmu.edu/documents/786/2007_005_001_14885.pdf), using its relative risk score.", - "owasp-risk-rating": "[OWASP Risk Rating](https://owasp.org/www-community/OWASP_Risk_Rating_Methodology), averaging likelihood and impact factors each scored 0 to 9.", - "qualitative-matrix": "A qualitative risk matrix that derives a risk level by plotting a likelihood band against an impact band, such as a five by five matrix producing a score from 1 to 25." + "owasp-risk-rating": "[OWASP Risk Rating](https://owasp.org/www-community/OWASP_Risk_Rating_Methodology), averaging likelihood and impact factors each scored `0` to `9`.", + "qualitative-matrix": "A qualitative risk matrix that derives a risk level by plotting a likelihood band against an impact band, such as a five by five matrix producing a score from `1` to `25`." } }, { diff --git a/schema/2.0/model/cyclonedx-usecase-2.0.schema.json b/schema/2.0/model/cyclonedx-usecase-2.0.schema.json index 3c7ef28e5..45dd0bafe 100644 --- a/schema/2.0/model/cyclonedx-usecase-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-usecase-2.0.schema.json @@ -147,7 +147,7 @@ "type": "integer", "title": "Number", "minimum": 1, - "description": "The sequence number indicating the ordinal position of this step within its flow, starting at 1." + "description": "The sequence number indicating the ordinal position of this step within its flow, starting at `1`." }, "description": { "type": "string", diff --git a/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json b/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json index b2cb5180e..6f90b6caf 100644 --- a/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json @@ -592,7 +592,7 @@ "minimum": 0, "maximum": 1, "title": "Confidence", - "description": "The overall confidence of the determination from 0 to 1, where 1 is 100% confidence." + "description": "The overall confidence of the determination from `0` to `1`, where `1` is 100% confidence." }, "concludedValue": { "type": "string", From dc2744a2435248d980c5142d6c7b5be7cdbfc731 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Thu, 10 Sep 2026 09:40:29 +0200 Subject: [PATCH 03/30] fix Signed-off-by: Jan Kowalleck --- schema/2.0/model/cyclonedx-component-2.0.schema.json | 8 ++++---- schema/2.0/model/cyclonedx-cryptography-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-party-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-physical-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-release-notes-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-threat-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/schema/2.0/model/cyclonedx-component-2.0.schema.json b/schema/2.0/model/cyclonedx-component-2.0.schema.json index 1ffb6bef3..7af62c299 100644 --- a/schema/2.0/model/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-component-2.0.schema.json @@ -53,7 +53,7 @@ "machine-learning-model": "A model based on training data that can make predictions or decisions without being explicitly programmed to do so.", "data": "A collection of discrete values that convey information.", "cryptographic-asset": "A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets.", - "material": "A physical substance in raw or processed form that is used to make, maintain, or repair an item, such as a metal, alloy, polymer, chemical, or other matter. Materials are commonly tracked for sourcing, provenance, and regulatory compliance. A finished physical item should be classified as 'type=\"device\"` instead.", + "material": "A physical substance in raw or processed form that is used to make, maintain, or repair an item, such as a metal, alloy, polymer, chemical, or other matter. Materials are commonly tracked for sourcing, provenance, and regulatory compliance. A finished physical item should be classified as `type=\"device\"` instead.", "service": "A service, including microservices, function-as-a-service, and other types of network or intra-process services. Service-specific attributes, endpoints and the data profiles characterizing the data the service handles, apply exclusively to this component type." }, "title": "Component Type", @@ -128,7 +128,7 @@ "excluded": "Components that are excluded provide the ability to document component usage for test and other non-runtime purposes. Excluded components are not reachable within a call graph at runtime." }, "title": "Component Scope", - "description": "Specifies the scope of the component. If scope is not specified, '\"required\"' scope SHOULD be assumed by the consumer of the BOM.", + "description": "Specifies the scope of the component. If scope is not specified, `\"required\"` scope SHOULD be assumed by the consumer of the BOM.", "default": "required" }, "hashes": { @@ -311,7 +311,7 @@ } }, { - "description": "Requirement: 'versionRange' must not be present when 'isExternal=false`.", + "description": "Requirement: `versionRange` must not be present when `isExternal=false`.", "if": { "properties": { "isExternal": { "const": false } } }, @@ -808,7 +808,7 @@ "configurationRef": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", "title": "Configuration Reference", - "description": "The bom-ref of the configuration that determines this component's configuration. Typically points to a component with `type=\"data\"' whose `data.type=\"configuration\"`." + "description": "The bom-ref of the configuration that determines this component's configuration. Typically points to a component with `type=\"data\"` whose `data.type=\"configuration\"`." }, "changeMechanism": { "type": "array", diff --git a/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json b/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json index 6640a7afc..ec96aa7ce 100644 --- a/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json @@ -40,7 +40,7 @@ "primitive": { "type": "string", "title": "primitive", - "description": "Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (`\"drbg\"`, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (`\"mac\"`, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (`\"pke`\", e.g. RSA), extended output functions (`\"xof\"`, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (`\"ae\"`, e.g. AES-GCM) and the combination of multiple algorithms (`\"combiner\"`, e.g. SP800-56Cr2).", + "description": "Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (`\"drbg\"`, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (`\"mac\"`, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (`\"pke\"`, e.g. RSA), extended output functions (`\"xof\"`, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (`\"ae\"`, e.g. AES-GCM) and the combination of multiple algorithms (`\"combiner\"`, e.g. SP800-56Cr2).", "enum": [ "drbg", "mac", diff --git a/schema/2.0/model/cyclonedx-party-2.0.schema.json b/schema/2.0/model/cyclonedx-party-2.0.schema.json index ab7d29d7f..edc8de596 100644 --- a/schema/2.0/model/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-party-2.0.schema.json @@ -357,7 +357,7 @@ "name": { "type": "string", "title": "Name", - "description": "Label describing the URL, such as `\"homepage\"`, `\"support`, `\"press\"`, `\"status\"`, or `\"repository\"`.", + "description": "Label describing the URL, such as `\"homepage\"`, `\"support\"`, `\"press\"`, `\"status\"`, or `\"repository\"`.", "examples": [ "homepage", "support", "press", "status", "repository" ] }, "url": { diff --git a/schema/2.0/model/cyclonedx-physical-2.0.schema.json b/schema/2.0/model/cyclonedx-physical-2.0.schema.json index 6aff226b4..e727217e0 100644 --- a/schema/2.0/model/cyclonedx-physical-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-physical-2.0.schema.json @@ -79,7 +79,7 @@ "uniqueItems": true, "minItems": 1, "title": "Designators", - "description": "Reference designators identifying the placement on the assembly, such as `\"U5\"`, `\"R12\"`, `\"C3`\".", + "description": "Reference designators identifying the placement on the assembly, such as `\"U5\"`, `\"R12\"`, `\"C3`\"`.", "examples": [ [ "U5" ], [ "C3", "C4", "C9", "C11", "C14", "C15" ] ] }, "layer": { diff --git a/schema/2.0/model/cyclonedx-release-notes-2.0.schema.json b/schema/2.0/model/cyclonedx-release-notes-2.0.schema.json index b1b91b808..9e5566b39 100644 --- a/schema/2.0/model/cyclonedx-release-notes-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-release-notes-2.0.schema.json @@ -87,7 +87,7 @@ "pre-release", "internal" ], - "description": "The software versioning type. It is recommended that the release type use one of `\"major\"`, `\"minor\"`, `\"patch\", `\"pre-release\"`, or `\"internal\"`. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it." + "description": "The software versioning type. It is recommended that the release type use one of `\"major\"`, `\"minor\"`, `\"patch\"`, `\"pre-release\"`, or `\"internal\"`. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it." }, "note": { "type": "object", diff --git a/schema/2.0/model/cyclonedx-threat-2.0.schema.json b/schema/2.0/model/cyclonedx-threat-2.0.schema.json index f491dee0f..1bf44538b 100644 --- a/schema/2.0/model/cyclonedx-threat-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-threat-2.0.schema.json @@ -908,7 +908,7 @@ "operator": { "type": "string", "title": "Operator", - "description": "Specifies how the nodes listed in `children` combine to achieve this node. A value of `\"and\"` requires every child node; a value of `\"or\"` requires any single child node. For example, a node whose children are a phishing node and a credential-stuffing node uses 'or' when either alone achieves it, or `\"and\"` when both are needed together. A node with no children is a leaf and omits this property.", + "description": "Specifies how the nodes listed in `children` combine to achieve this node. A value of `\"and\"` requires every child node; a value of `\"or\"` requires any single child node. For example, a node whose children are a phishing node and a credential-stuffing node uses `\"or\"` when either alone achieves it, or `\"and\"` when both are needed together. A node with no children is a leaf and omits this property.", "enum": [ "and", "or" diff --git a/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json b/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json index 6f90b6caf..271d86735 100644 --- a/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json @@ -258,7 +258,7 @@ }, "evidence": { "$ref": "#/$defs/vulnerabilityEvidence", - "description": "Evidence collected through extraction or analysis that substantiates the presence, absence, or exploitability of the vulnerability in the affected components. Evidence supports both positive determinations, such as a confirmed exploitable finding, and negative determinations, such as a `impactAnalysisState=\"not_affected\"` conclusion, and complements the impact analysis and the proof of concept." + "description": "Evidence collected through extraction or analysis that substantiates the presence, absence, or exploitability of the vulnerability in the affected components. Evidence supports both positive determinations, such as a confirmed exploitable finding, and negative determinations, such as a not_affected conclusion, and complements the impact analysis and the proof of concept." }, "affects": { "type": "array", From 653592343ae21689790e8afc04c131961e91be9a Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Thu, 10 Sep 2026 09:43:29 +0200 Subject: [PATCH 04/30] fix Signed-off-by: Jan Kowalleck --- schema/2.0/model/cyclonedx-common-2.0.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/model/cyclonedx-common-2.0.schema.json b/schema/2.0/model/cyclonedx-common-2.0.schema.json index e8acf76a3..898396d6f 100644 --- a/schema/2.0/model/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-common-2.0.schema.json @@ -6,7 +6,7 @@ "$comment" : "OWASP CycloneDX is an Ecma International standard (ECMA-424) developed in collaboration between the OWASP Foundation and Ecma Technical Committee 54 (TC54). The standard is published under a royalty-free patent policy. This JSON schema is the reference implementation and is licensed under the Apache License 2.0.", "$defs": { "refType": { - "description": "Identifier for referable and therefore interlinkable elements.\nValue shall not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.", + "description": "Identifier for referable and therefore interlinkable elements.\nValue shall not start with the BOM-Link intro `\"urn:cdx:\"` to avoid conflicts with BOM-Links.", "type": "string", "minLength": 1, "pattern": "^(?!urn:cdx:)" From f5b2e1f1e8306a2bf848b9d32ed69d33cc41e82f Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Thu, 10 Sep 2026 09:43:47 +0200 Subject: [PATCH 05/30] fix Signed-off-by: Jan Kowalleck --- schema/2.0/model/cyclonedx-common-2.0.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/model/cyclonedx-common-2.0.schema.json b/schema/2.0/model/cyclonedx-common-2.0.schema.json index 898396d6f..0872056f8 100644 --- a/schema/2.0/model/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-common-2.0.schema.json @@ -14,7 +14,7 @@ "refLinkType": { "description": "Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.\nIn contrast to `bomLinkElementType`.", "allOf": [{ "$ref": "#/$defs/refType" }], - "$comment": "value-range is same as 'refType'" + "$comment": "value-range is same as `refType`" }, "bomLinkDocumentType": { "title": "BOM-Link Document", From 174ea95a19e58adf50cd50a905efa3b4b5cf96d4 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Thu, 10 Sep 2026 10:36:54 +0200 Subject: [PATCH 06/30] fix Signed-off-by: Jan Kowalleck --- schema/2.0/model/cyclonedx-blueprint-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-common-2.0.schema.json | 4 ++-- schema/2.0/model/cyclonedx-component-2.0.schema.json | 12 ++++++------ .../2.0/model/cyclonedx-cryptography-2.0.schema.json | 4 ++-- schema/2.0/model/cyclonedx-evidence-2.0.schema.json | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json b/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json index 62c99dfc9..214454930 100644 --- a/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-blueprint-2.0.schema.json @@ -410,7 +410,7 @@ }, "componentRef": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", - "description": "Reference using bom-link or bom-ref to the component this asset represents, including components of type `\"service\"`." + "description": "Reference using bom-link or bom-ref to the component this asset represents, including components with `type=\"service\"`." }, "partyRef": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", diff --git a/schema/2.0/model/cyclonedx-common-2.0.schema.json b/schema/2.0/model/cyclonedx-common-2.0.schema.json index 0872056f8..3c031cd08 100644 --- a/schema/2.0/model/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-common-2.0.schema.json @@ -12,7 +12,7 @@ "pattern": "^(?!urn:cdx:)" }, "refLinkType": { - "description": "Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.\nIn contrast to `bomLinkElementType`.", + "description": "Descriptor for an element identified by the attribute `bom-ref` in the same BOM document.\nIn contrast to `bomLinkElementType`.", "allOf": [{ "$ref": "#/$defs/refType" }], "$comment": "value-range is same as `refType`" }, @@ -547,7 +547,7 @@ "isoCode": { "type": "string", "title": "ISO Code", - "description": "The country or subdivision of origin, expressed as an ISO 3166-1 alpha-2 country code (for example, 'CA' for Canada) or an ISO 3166-2 subdivision code (for example, `\"US-CA\"` for California, United States).", + "description": "The country or subdivision of origin, expressed as an ISO 3166-1 alpha-2 country code (for example, `\"CA\"` for Canada) or an ISO 3166-2 subdivision code (for example, `\"US-CA\"` for California, United States).", "pattern": "^[A-Z]{2}(-[A-Z0-9]{1,3})?$", "examples": [ "CA", "US-CA" ] }, diff --git a/schema/2.0/model/cyclonedx-component-2.0.schema.json b/schema/2.0/model/cyclonedx-component-2.0.schema.json index 7af62c299..28f1d281b 100644 --- a/schema/2.0/model/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-component-2.0.schema.json @@ -46,14 +46,14 @@ "container": "A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization).", "platform": "A runtime environment that interprets or executes software. This may include runtimes such as those that execute bytecode, just-in-time compilers, interpreters, or low-code/no-code application platforms.", "operating-system": "A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system).", - "device": "A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of `type=\"firmware\"` or `type=\"operating-system\"` (whichever is relevant), describing information about the software running on the device. See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).", + "device": "A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component with `type=\"firmware\"` or `type=\"operating-system\"` (whichever is relevant), describing information about the software running on the device. See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).", "device-driver": "A special type of software that operates or controls a particular type of device. Refer to [https://en.wikipedia.org/wiki/Device_driver](https://en.wikipedia.org/wiki/Device_driver).", "firmware": "A special type of software that provides low-level control over a device's hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware).", "file": "A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.", "machine-learning-model": "A model based on training data that can make predictions or decisions without being explicitly programmed to do so.", "data": "A collection of discrete values that convey information.", "cryptographic-asset": "A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets.", - "material": "A physical substance in raw or processed form that is used to make, maintain, or repair an item, such as a metal, alloy, polymer, chemical, or other matter. Materials are commonly tracked for sourcing, provenance, and regulatory compliance. A finished physical item should be classified as `type=\"device\"` instead.", + "material": "A physical substance in raw or processed form that is used to make, maintain, or repair an item, such as a metal, alloy, polymer, chemical, or other matter. Materials are commonly tracked for sourcing, provenance, and regulatory compliance. A finished physical item should be classified with `type=\"device\"` instead.", "service": "A service, including microservices, function-as-a-service, and other types of network or intra-process services. Service-specific attributes, endpoints and the data profiles characterizing the data the service handles, apply exclusively to this component type." }, "title": "Component Type", @@ -239,7 +239,7 @@ "classification": { "$ref": "cyclonedx-physical-2.0.schema.json#/$defs/classification", "title": "Classification", - "description": "Hierarchical classification of the item, with optional taxonomy codes from external standards. This object may only be specified for components with `type=\"device\"` or `type=\"material\"` and shall not be specified for other component types." + "description": "Hierarchical classification of the item, with optional taxonomy codes from external standards. This object may only be specified for components with `type=\"device\"` or `type=\"material\"`, and shall not be specified for other component types." }, "boardLocation": { "$ref": "cyclonedx-physical-2.0.schema.json#/$defs/boardLocation", @@ -254,7 +254,7 @@ "leadTime": { "$ref": "cyclonedx-physical-2.0.schema.json#/$defs/leadTime", "title": "Lead Time", - "description": "Supplier lead time for procuring the item. This object may only be specified for components with `type=\"device\"` or `type=\"material\"` and shall not be specified for other component types." + "description": "Supplier lead time for procuring the item. This object may only be specified for components with `type=\"device\"` or `type=\"material\"`, and shall not be specified for other component types." }, "materialForm": { "$ref": "cyclonedx-physical-2.0.schema.json#/$defs/materialForm", @@ -264,7 +264,7 @@ "quantity": { "$ref": "cyclonedx-physical-2.0.schema.json#/$defs/quantity", "title": "Quantity", - "description": "The quantity of the item in the context in which it is declared, such as the number of identical parts within the enclosing assembly or the amount of material in the described lot. This object may only be specified for components with `type=\"device\"` or `type=\"material\"` and shall not be specified for other component types." + "description": "The quantity of the item in the context in which it is declared, such as the number of identical parts within the enclosing assembly or the amount of material in the described lot. This object may only be specified for components with `type=\"device\"` or `type=\"material\"`, and shall not be specified for other component types." }, "certifications": { "$ref": "cyclonedx-certification-2.0.schema.json#/$defs/certifications", @@ -808,7 +808,7 @@ "configurationRef": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", "title": "Configuration Reference", - "description": "The bom-ref of the configuration that determines this component's configuration. Typically points to a component with `type=\"data\"` whose `data.type=\"configuration\"`." + "description": "The bom-ref of the configuration that determines this component's configuration. Typically points to a component with `type=\"data\"` and `data.type=\"configuration\"`." }, "changeMechanism": { "type": "array", diff --git a/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json b/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json index ec96aa7ce..d30d00b17 100644 --- a/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-cryptography-2.0.schema.json @@ -362,7 +362,7 @@ "certificateProperties": { "type": "object", "title": "Certificate Properties", - "description": "Properties for cryptographic assets where `assetType=\"certificate\"`.", + "description": "Properties for cryptographic assets with `assetType=\"certificate\"`.", "additionalProperties": false, "properties": { "serialNumber": { @@ -612,7 +612,7 @@ "relatedCryptoMaterialProperties": { "type": "object", "title": "Related Cryptographic Material Properties", - "description": "Properties for cryptographic assets where `assetType=\"related-crypto-material\"`.", + "description": "Properties for cryptographic assets with `assetType=\"related-crypto-material\"`.", "additionalProperties": false, "properties": { "type": { diff --git a/schema/2.0/model/cyclonedx-evidence-2.0.schema.json b/schema/2.0/model/cyclonedx-evidence-2.0.schema.json index 46a89bda0..e27a726cb 100644 --- a/schema/2.0/model/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-evidence-2.0.schema.json @@ -248,7 +248,7 @@ "text": { "type": "string", "title": "Text", - "description": "The rule, policy, or query text. Large or sensitive rule content should instead be referenced through supporting data of type `rule`." + "description": "The rule, policy, or query text. Large or sensitive rule content should instead be referenced through supporting data with `type=\"rule\"`." } } }, From 45e86089989f2322cb17b09e5af9ffb19a6612ae Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Thu, 10 Sep 2026 11:04:30 +0200 Subject: [PATCH 07/30] fix Signed-off-by: Jan Kowalleck --- schema/2.0/cyclonedx-2.0-bundled.schema.json | 4 ++-- schema/2.0/model/cyclonedx-component-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-cryptography-2.0.schema.json | 4 ++-- schema/2.0/model/cyclonedx-formulation-2.0.schema.json | 6 +++--- schema/2.0/model/cyclonedx-physical-2.0.schema.json | 2 +- schema/2.0/model/cyclonedx-vulnerability-2.0.schema.json | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/schema/2.0/cyclonedx-2.0-bundled.schema.json b/schema/2.0/cyclonedx-2.0-bundled.schema.json index e97adfb6a..b2782cbca 100644 --- a/schema/2.0/cyclonedx-2.0-bundled.schema.json +++ b/schema/2.0/cyclonedx-2.0-bundled.schema.json @@ -4345,7 +4345,7 @@ "extensibleProperties": { "type": "object", "title": "Extensible Properties", - "$comment": "This is a mixin. It intentionally does NOT restrict additional/unevaluated properties itself; schemas composing it via `allOf` are expected to close themselves with `unevaluatedProperties: false` so that both their own defined properties and these patternProperties remain usable.", + "$comment": "This is a mixin. It intentionally does NOT restrict additional/unevaluated properties itself; schemas composing it via `allOf` are expected to close themselves with `unevaluatedProperties=false` so that both their own defined properties and these patternProperties remain usable.", "patternProperties": { "^ext:[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}:.+$": { "description": "CycloneDX supports a structured and namespace-aware mechanism for extensibility through the use of extensible properties. This mechanism enables organizations, ecosystems, and tool vendors to safely introduce custom properties without conflicting with the core schema or other extensions.\n\nExtensible properties are defined as a JSON object whose keys must conform to a strict pattern that resembles a reverse domain name structure, prefixed with ext:. This pattern provides a namespacing convention that aligns with well-established practices in other structured formats (e.g., XML namespaces).\n\nValues that are objects must declare the schema they conform to via `$schema`. This requirement applies recursively to objects contained in arrays, at any nesting depth.", @@ -4406,7 +4406,7 @@ "baseObject": { "type": "object", "description": "Base object for all CycloneDX entities. Automatically includes support for extensible properties.", - "$comment": "This is a mixin. It intentionally does NOT set `unevaluatedProperties: false` — that keyword cannot see properties defined by schemas composing this one via `allOf`, and would reject them. Concrete (leaf) schemas composing this mixin must close themselves with `unevaluatedProperties: false`.", + "$comment": "This is a mixin. It intentionally does NOT set `unevaluatedProperties=false` — that keyword cannot see properties defined by schemas composing this one via `allOf`, and would reject them. Concrete (leaf) schemas composing this mixin must close themselves with `unevaluatedProperties=false`.", "allOf": [ { "$ref": "#/$defs/cyclonedx-common-2.0/$defs/extensibleProperties" diff --git a/schema/2.0/model/cyclonedx-component-2.0.schema.json b/schema/2.0/model/cyclonedx-component-2.0.schema.json index 28f1d281b..67923069d 100644 --- a/schema/2.0/model/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/model/cyclonedx-component-2.0.schema.json @@ -102,7 +102,7 @@ "versionRange": { "$ref": "#/$defs/versionRange", "title": "Component Version Range", - "description": "For an external component, this specifies the accepted version range.\nThe value must adhere to the Package URL Version Range syntax (vers), as defined at Date: Mon, 9 Nov 2026 15:34:20 +0100 Subject: [PATCH 08/30] docs: streamline descriptions Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json b/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json index a2c3fe5bd..22b501d68 100644 --- a/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json @@ -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": [ { From a29f633c2ed4d207e61279963f7ac52cb9884b6b Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 9 Nov 2026 15:46:54 +0100 Subject: [PATCH 09/30] docs: streamline descriptions Signed-off-by: Jan Kowalleck --- schema/2.0/cyclonedx-2.0.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/cyclonedx-2.0.schema.json b/schema/2.0/cyclonedx-2.0.schema.json index 0c2fb7b6a..821075155 100644 --- a/schema/2.0/cyclonedx-2.0.schema.json +++ b/schema/2.0/cyclonedx-2.0.schema.json @@ -42,7 +42,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 }, From b6ccf7f08dc921c3bcc8ac163c96407c91154a8c Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 9 Nov 2026 17:31:33 +0100 Subject: [PATCH 10/30] update Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-ai-modelcard-2.0.schema.json | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 schema/2.0/modules/cyclonedx-ai-modelcard-2.0.schema.json diff --git a/schema/2.0/modules/cyclonedx-ai-modelcard-2.0.schema.json b/schema/2.0/modules/cyclonedx-ai-modelcard-2.0.schema.json deleted file mode 100644 index e69de29bb..000000000 From bd372e0c5d80f2490f125f6bb47169f170614b4c Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 9 Nov 2026 17:51:12 +0100 Subject: [PATCH 11/30] update docs Signed-off-by: Jan Kowalleck --- .../modules/cyclonedx-ai-ml-2.0.schema.json | 10 ++++----- .../cyclonedx-behavior-2.0.schema.json | 4 ++-- .../cyclonedx-blueprint-2.0.schema.json | 4 ++-- .../modules/cyclonedx-common-2.0.schema.json | 4 ++-- .../cyclonedx-component-2.0.schema.json | 4 ++-- .../cyclonedx-cryptography-2.0.schema.json | 8 +++---- .../modules/cyclonedx-data-2.0.schema.json | 12 +++++----- .../cyclonedx-declaration-2.0.schema.json | 4 ++-- .../cyclonedx-evidence-2.0.schema.json | 4 ++-- .../cyclonedx-formulation-2.0.schema.json | 4 ++-- ...cyclonedx-jss_X590_2023_10-2.0.schema.json | 22 +++++++++---------- .../modules/cyclonedx-party-2.0.schema.json | 6 ++--- .../modules/cyclonedx-patent-2.0.schema.json | 2 +- .../modules/cyclonedx-risk-2.0.schema.json | 6 ++--- .../modules/cyclonedx-threat-2.0.schema.json | 2 +- .../cyclonedx-vulnerability-2.0.schema.json | 14 ++++++------ .../cyclonedx-weakness-2.0.schema.json | 4 ++-- 17 files changed, 57 insertions(+), 57 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json b/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json index 22b501d68..f891b1d9b 100644 --- a/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json @@ -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": { @@ -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, @@ -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, @@ -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 } } @@ -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", diff --git a/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json b/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json index 1a56b5147..cabcc1a6d 100644 --- a/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json @@ -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", @@ -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", diff --git a/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json b/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json index dc45c7f7c..7e5bb66b0 100644 --- a/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json @@ -460,7 +460,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.", @@ -1117,7 +1117,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" diff --git a/schema/2.0/modules/cyclonedx-common-2.0.schema.json b/schema/2.0/modules/cyclonedx-common-2.0.schema.json index 8b7a736fd..fd1c6610c 100644 --- a/schema/2.0/modules/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-common-2.0.schema.json @@ -299,7 +299,7 @@ "patent-family": "References information about a patent family which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. A patent family is a group of related patent applications or granted patents that cover the same or similar invention. For detailed patent family information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as [ST.96](https://www.wipo.int/standards/en/st96).", "patent-assertion" : "References assertions made regarding patents associated with a component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents.", "citation": "A reference to external citations applicable to the object identified in a CycloneDX artifact or payload or the CycloneDX artifact or payload itself. When used with a BOM-Link, this allows offloading citations into a separate CycloneDX artifacts or payloads.", - "swid-tag": "A Software Identification (SWID) tag document conforming to ISO/IEC 19770-2. The reference resolves to the XML SoftwareIdentity document itself, including all of its metadata (entities, evidence, payload, links, and meta elements). This is distinct from the \"swid\" identifier scheme, which carries only the tagId of a SWID tag.", + "swid-tag": "A Software Identification (SWID) tag document conforming to ISO/IEC 19770-2. The reference resolves to the XML SoftwareIdentity document itself, including all of its metadata (entities, evidence, payload, links, and meta elements). This is distinct from the `\"swid\"` identifier scheme, which carries only the tagId of a SWID tag.", "gs1-digital-link": "A [GS1 Digital Link URI](https://ref.gs1.org/standards/digital-link/uri-syntax/) that connects the component's GS1 identification key, such as a GTIN, to online sources of information, including product data, safety documentation, digital product passports, and recall status. The URI may include key qualifiers, such as a batch or serial number, enabling identification at the class, batch, or individual item level. Component identity shall be derived from the component's identifiers, not from keys embedded in this URI.", "other": "Use this if no other types accurately describe the purpose of the external reference." } @@ -1052,7 +1052,7 @@ }, "unitSymbol": { "title": "Unit Symbol", - "description": "A predefined unit symbol. The symbols cover time, data size, throughput, compute, energy, carbon dioxide equivalent, and ratio quantities. The unit one, written as 1, is used for counts and dimensionless quantities. Where a symbol differs from its UCUM code, the code is noted in its definition.", + "description": "A predefined unit symbol. The symbols cover time, data size, throughput, compute, energy, carbon dioxide equivalent, and ratio quantities. The unit one, written as `\"1\"`, is used for counts and dimensionless quantities. Where a symbol differs from its UCUM code, the code is noted in its definition.", "type": "string", "enum": [ "ns", diff --git a/schema/2.0/modules/cyclonedx-component-2.0.schema.json b/schema/2.0/modules/cyclonedx-component-2.0.schema.json index 5ebf74de7..e78944467 100644 --- a/schema/2.0/modules/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-component-2.0.schema.json @@ -242,7 +242,7 @@ "modelProperties": { "$ref": "cyclonedx-ai-ml-2.0.schema.json#/$defs/modelProperties", "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." + "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." }, "data": { "type": "array", @@ -396,7 +396,7 @@ }, { "title": "Service Requirement", - "description": "Requirement: endpoints and dataProfiles may only be used for components with `type=\"service\"`.", + "description": "Requirement: `endpoints` and `dataProfiles` may only be used for components with `type=\"service\"`.", "if": { "properties": { "type": { "const": "service" } } }, diff --git a/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json b/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json index 76da563c9..96342d40e 100644 --- a/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json @@ -256,7 +256,7 @@ "nistQuantumSecurityLevel": { "type": "integer", "title": "NIST security strength category", - "description": "The NIST security strength category as defined in https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria). NIST defines categories 1 through 5. CycloneDX uses 0 to indicate that none of these categories are met. Omission makes no category assertion and does not establish whether an assessment was performed.", + "description": "The NIST security strength category as defined in https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria). NIST defines categories `1` through `5`. CycloneDX uses `0` to indicate that none of these categories are met. Omission makes no category assertion and does not establish whether an assessment was performed.", "minimum": 0, "maximum": 5 }, @@ -537,7 +537,7 @@ "properties": { "type": { "title": "relatedCryptoMaterialType", - "description": "The type for the related cryptographic material. Select the most specific applicable type according to the role of the material in the described cryptographic context. Broader categories, such as `key` and `credential`, can be used when a more specific classification is unavailable or does not apply. Types can overlap; for example, a password is also a credential, but should be classified as `password` when that type is known.", + "description": "The type for the related cryptographic material. Select the most specific applicable type according to the role of the material in the described cryptographic context. Broader categories, such as `\"key\"` and `\"credential\"`, can be used when a more specific classification is unavailable or does not apply. Types can overlap; for example, a password is also a credential, but should be classified as `\"password\"` when that type is known.", "enum": [ "private-key", "public-key", @@ -563,7 +563,7 @@ "private-key": "The confidential key of a key pair used in asymmetric cryptography.", "public-key": "The non-confidential key of a key pair used in asymmetric cryptography.", "secret-key": "A key used with a symmetric cryptographic algorithm, for example for encryption, message authentication, key wrapping, or key derivation.", - "key": "A cryptographic key whose more specific type is unknown or is not covered by the available key types. Use `private-key`, `public-key`, or `secret-key` when that classification is known and applicable.", + "key": "A cryptographic key whose more specific type is unknown or is not covered by the available key types. Use `\"private-key\"`, `\"public-key\"`, or `\"secret-key\"` when that classification is known and applicable.", "ciphertext": "The result of encryption performed on plaintext using an algorithm (or cipher).", "signature": "A cryptographic value that is calculated from the data and a key known only by the signer.", "digest": "The output of the hash function.", @@ -571,7 +571,7 @@ "nonce": "A value used only once within a defined cryptographic context, such as encryption operations under a particular key.", "seed": "The input to a pseudo-random number generator. Different seeds generate different pseudo-random sequences.", "salt": "A value used to diversify a cryptographic computation, such as password hashing, key derivation, or randomized signing.", - "shared-secret": "Secret data shared between parties, for example material established through key agreement or key encapsulation and used as input to key derivation. When describing its role as a symmetric key, use `secret-key`.", + "shared-secret": "Secret data shared between parties, for example material established through key agreement or key encapsulation and used as input to key derivation. When describing its role as a symmetric key, use `\"secret-key\"`.", "tag": "A message authentication code (MAC), sometimes known as an authentication tag, is a short piece of information used for authenticating and integrity-checking a message.", "additional-data": "An unspecified collection of data with relevance to cryptographic activity.", "password": "A secret word, phrase, or sequence of characters used during authentication or authorization.", diff --git a/schema/2.0/modules/cyclonedx-data-2.0.schema.json b/schema/2.0/modules/cyclonedx-data-2.0.schema.json index c320e5914..2e2906fb9 100644 --- a/schema/2.0/modules/cyclonedx-data-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-data-2.0.schema.json @@ -132,11 +132,11 @@ }, "jurisdictions": { "$ref": "#/$defs/jurisdictions", - "description": "The jurisdictions whose laws and regulations apply to this data based on its nature, classification, or how it is processed and stored. See also subject.jurisdictions for jurisdictions that apply because of who the data is about." + "description": "The jurisdictions whose laws and regulations apply to this data based on its nature, classification, or how it is processed and stored. See also `subject.jurisdictions` for jurisdictions that apply because of who the data is about." }, "regulations": { "$ref": "#/$defs/regulations", - "description": "The regulations that apply to this data based on its nature, classification, or processing context. See also subject.regulations for regulations that apply because of who the data is about." + "description": "The regulations that apply to this data based on its nature, classification, or processing context. See also `subject.regulations` for regulations that apply because of who the data is about." }, "dataFormats": { "type": "array", @@ -343,7 +343,7 @@ "mediaType": { "type": "string", "title": "Media Type", - "description": "Media type of the schema, for example application/schema+json, application/xml, or application/vnd.apache.avro+json.", + "description": "Media type of the schema, for example `\"application/schema+json\"`, `\"application/xml\"`, or `\"application/vnd.apache.avro+json\"`.", "examples": [ "application/schema+json", "application/xml", @@ -664,15 +664,15 @@ "protectedClass": { "type": "boolean", "title": "Protected Class", - "description": "Indicates whether this subject represents or includes a legally protected class under applicable regulations. Protected classes are groups defined by characteristics such as race, ethnicity, religion, gender, age, disability, sexual orientation, national origin, or genetic information. When true, additional regulatory obligations may apply to the collection, processing, and sharing of data about this subject, including GDPR special category data provisions, US civil rights protections, COPPA requirements for children, and HIPAA protections for health information." + "description": "Indicates whether this subject represents or includes a legally protected class under applicable regulations. Protected classes are groups defined by characteristics such as race, ethnicity, religion, gender, age, disability, sexual orientation, national origin, or genetic information. When `true`, additional regulatory obligations may apply to the collection, processing, and sharing of data about this subject, including GDPR special category data provisions, US civil rights protections, COPPA requirements for children, and HIPAA protections for health information." }, "jurisdictions": { "$ref": "#/$defs/jurisdictions", - "description": "The jurisdictions whose laws and regulations apply specifically because of this subject. See also dataProfile.jurisdictions for jurisdictions that apply to the data itself." + "description": "The jurisdictions whose laws and regulations apply specifically because of this subject. See also `dataProfile.jurisdictions` for jurisdictions that apply to the data itself." }, "regulations": { "$ref": "#/$defs/regulations", - "description": "The regulations that apply specifically because of this subject. See also dataProfile.regulations for regulations that apply to the data itself." + "description": "The regulations that apply specifically because of this subject. See also `dataProfile.regulations` for regulations that apply to the data itself." }, "description": { "type": "string", diff --git a/schema/2.0/modules/cyclonedx-declaration-2.0.schema.json b/schema/2.0/modules/cyclonedx-declaration-2.0.schema.json index c2ad503e3..f9f6e1e1c 100644 --- a/schema/2.0/modules/cyclonedx-declaration-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-declaration-2.0.schema.json @@ -29,7 +29,7 @@ "thirdParty": { "type": "boolean", "title": "Third Party", - "description": "The boolean indicating if the assessor is outside the organization generating claims. A value of false indicates a self assessor." + "description": "The boolean indicating if the assessor is outside the organization generating claims. A value of `false` indicates a self assessor." }, "organization": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/organizationalEntity", @@ -183,7 +183,7 @@ "counterEvidence": { "type": "array", "title": "Counter Evidence", - "description": "The list of `refId` to counterEvidence that supports this claim.", + "description": "The list of `refId` to `counterEvidence` that supports this claim.", "items": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType" } }, "externalReferences": { diff --git a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json index 2fff53a63..33833a56c 100644 --- a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json @@ -366,7 +366,7 @@ }, "assessmentMethod": { "title": "Assessment Method", - "description": "A method of analysis used to assess a vulnerability. The technique is constrained to those meaningful for assessment; the identification-only `filename` technique is not permitted.", + "description": "A method of analysis used to assess a vulnerability. The technique is constrained to those meaningful for assessment; the identification-only `\"filename\"` technique is not permitted.", "allOf": [ { "$ref": "#/$defs/analysisMethod" }, { @@ -416,7 +416,7 @@ "role": { "$ref": "cyclonedx-party-2.0.schema.json#/$defs/role", "title": "Role", - "description": "The role or vantage in which the party was involved, for example supplier, manufacturer, distributor, operator, customer, end-user, asserter, auditor, reviewer, or researcher." + "description": "The role or vantage in which the party was involved, for example `\"supplier\"`, `\"manufacturer\"`, `\"distributor\"`, `\"operator\"`, `\"customer\"`, `\"end-user\"`, `\"asserter\"`, `\"auditor\"`, `\"reviewer\"`, or `\"researcher\"`." } } }, diff --git a/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json b/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json index 964020c1e..b6d414347 100644 --- a/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json @@ -675,7 +675,7 @@ "properties": { "source": { "title": "Source", - "description": "A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of `inbound`)", + "description": "A reference to the component or service that provided the input to the task (e.g., reference to a service with `flow=\"inbound\"`)", "examples": [ "source code repository", "database" @@ -761,7 +761,7 @@ }, "target": { "title": "Target", - "description": "Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of `outbound`)", + "description": "Component or service that received the output from the task (e.g., reference to an artifactory service with `flow=\"outbound\"`)", "examples": ["a log file described as an `externalReference` within its target domain."], "$ref": "#/$defs/resourceReferenceChoice" }, diff --git a/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json b/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json index e69d8fe40..575e7dafb 100644 --- a/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json @@ -44,7 +44,7 @@ }, "hashAlgorithm": { "title": "Hash Algorithm", - "description": "This property identifies the hashing algorithm, as defined by the Internet Assigned Numbers Authority (IANA)…, that was used to hash the JCS version of the full JSON object (JSON Object + JSS Signature) and is a case-sensitive ASCII string. Implementations MAY use any current and widely accepted hashing algorithm (e.g., `\"sha-256\"`, `\"sha-512\"`) that is defined in the IANA registry. The actual signing process, defined in the algorithm property, sometimes uses an internal hashing algorithm inside the signing process itself, this property MAY identify the same hashing algorithm as the signing process or MAY identify a different hashing algorithm.", + "description": "This property identifies the hashing algorithm, as defined by the Internet Assigned Numbers Authority (IANA)…, that was used to hash the JCS version of the full JSON object (JSON Object + JSS Signature) and is a case-sensitive ASCII string. Implementations MAY use any current and widely accepted hashing algorithm (e.g., `\"sha-256\"`, `\"sha-512\"`) that is defined in the IANA registry. The actual signing process, defined in the `algorithm` property, sometimes uses an internal hashing algorithm inside the signing process itself, this property MAY identify the same hashing algorithm as the signing process or MAY identify a different hashing algorithm.", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "string", "pattern": "^[a-z0-9-]+$", @@ -101,7 +101,7 @@ }, "publicKey": { "title": "Public Key (PEM, header-stripped)", - "description": "This property contains a privacy enhanced mail (PEM) encoded public key without the header and footer for the algorithm selected in the algorithm property.", + "description": "This property contains a privacy enhanced mail (PEM) encoded public key without the header and footer for the algorithm selected in the `algorithm` property.", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "string", "pattern": "^[A-Za-z0-9+/]+={0,2}$", @@ -111,7 +111,7 @@ }, "publicCertChain": { "title": "Public Certificate Chain", - "description": "This property contains a public key certificate for the algorithm selected in the algorithm property and MUST follow the requirements defined in section 4.7 of [IETF RFC 7517] as quoted here. This property \"contains a chain (X.509 certificate chain) of one or more PKIX certificates [IETF RFC 5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (section 4 of [IETF RFC 4648] – not base64URL.encoded) DER [b-ITU-T X.690] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. This MAY be followed by additional certificates, with each subsequent certificate being the one used to certify the previous one. The key in the first certificate MUST match the public key.\" This property is called \"x5c\" in section 4.7 of [IETF RFC 7517].", + "description": "This property contains a public key certificate for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.7 of [IETF RFC 7517] as quoted here. This property \"contains a chain (X.509 certificate chain) of one or more PKIX certificates [IETF RFC 5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (section 4 of [IETF RFC 4648] – not base64URL.encoded) DER [b-ITU-T X.690] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. This MAY be followed by additional certificates, with each subsequent certificate being the one used to certify the previous one. The key in the first certificate MUST match the public key.\" This property is called \"x5c\" in section 4.7 of [IETF RFC 7517].", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "array", "items": { @@ -122,7 +122,7 @@ }, "certUrl": { "title": "Certificate URL", - "description": "This property contains a uniform resource identifier (URI) [IETF RFC 3986] that refers to a resource for an X.509 public key certificate or certificate chain [IETF RFC 5280] for the algorithm selected in the algorithm property and MUST follow the requirements defined in section 4.6 of [IETF RFC 7517] as quoted here. \"The identified resource MUST provide a representation of the certificate or certificate chain that conforms to RFC 5280 [IETF RFC 5280] in PEM-encoded form, with each certificate delimited as specified in section 6.1 of RFC 4945 [IETF RFC 4945]. The key in the first certificate MUST match the public key. The protocol used to acquire the resource MUST provide integrity protection; an HTTP GET request to retrieve the certificate MUST use TLS [IETF RFC 2818] [IETF RFC 5246]; the identity of the server MUST be validated, as per section 6 of RFC 6125 [IETF RFC 6125].\" This property is called \"x5u\" in section 4.6 of [IETF RFC 7517].", + "description": "This property contains a uniform resource identifier (URI) [IETF RFC 3986] that refers to a resource for an X.509 public key certificate or certificate chain [IETF RFC 5280] for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.6 of [IETF RFC 7517] as quoted here. \"The identified resource MUST provide a representation of the certificate or certificate chain that conforms to RFC 5280 [IETF RFC 5280] in PEM-encoded form, with each certificate delimited as specified in section 6.1 of RFC 4945 [IETF RFC 4945]. The key in the first certificate MUST match the public key. The protocol used to acquire the resource MUST provide integrity protection; an HTTP GET request to retrieve the certificate MUST use TLS [IETF RFC 2818] [IETF RFC 5246]; the identity of the server MUST be validated, as per section 6 of RFC 6125 [IETF RFC 6125].\" This property is called \"x5u\" in section 4.6 of [IETF RFC 7517].", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "string", "format": "uri", @@ -133,7 +133,7 @@ }, "thumbprint": { "title": "Certificate Thumbprint", - "description": "This property contains a fingerprint of a public key or public key certificate for the algorithm selected in the algorithm property and MUST follow the requirements defined in section 4.9 of [IETF RFC 7517] as quoted here. This property \"is a base64URL.encoded SHA-256 thumbprint (a.k.a. digest, X.509 certificate SHA-256 thumbprint) of the DER encoding of an X.509 certificate [IETF RFC 5280]. Note that certificate thumbprints are also sometimes known as certificate fingerprints. The key in the certificate MUST match the public key.\" This property is called \"x5t#S256\" in section 4.9 of [IETF RFC 7517].", + "description": "This property contains a fingerprint of a public key or public key certificate for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.9 of [IETF RFC 7517] as quoted here. This property \"is a base64URL.encoded SHA-256 thumbprint (a.k.a. digest, X.509 certificate SHA-256 thumbprint) of the DER encoding of an X.509 certificate [IETF RFC 5280]. Note that certificate thumbprints are also sometimes known as certificate fingerprints. The key in the certificate MUST match the public key.\" This property is called \"x5t#S256\" in section 4.9 of [IETF RFC 7517].", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$", @@ -187,7 +187,7 @@ "id": { "$ref": "#/$defs/identifier", "title": "Signature Identifier", - "description": "A value that uniquely identifies the signature. All signatures with the same ID are considered different versions of the same signature and the version of the signature is identified by its modified property.", + "description": "A value that uniquely identifies the signature. All signatures with the same ID are considered different versions of the same signature and the version of the signature is identified by its `modified` property.", "$comment": "Normative source: ITU-T X.590 clause 6.3.1" }, "related_to": { @@ -205,18 +205,18 @@ "created": { "$ref": "#/$defs/timestamp/$defs/withMilliseconds", "title": "Created Timestamp", - "description": "The time at which this signature was originally created. The creator can use any time it deems most appropriate as the time the signature was created, but it MUST be precise to the nearest millisecond (exactly three digits after the decimal place in seconds). The created property MUST NOT be changed when creating a new version of the signature.", + "description": "The time at which this signature was originally created. The creator can use any time it deems most appropriate as the time the signature was created, but it MUST be precise to the nearest millisecond (exactly three digits after the decimal place in seconds). The `created` property MUST NOT be changed when creating a new version of the signature.", "$comment": "Normative source: ITU-T X.590 clause 6.3.1" }, "modified": { "$ref": "#/$defs/timestamp/$defs/withMilliseconds", "title": "Modified Timestamp", - "description": "The time that this particular version of the signature was last modified. The creator can use any time it deems most appropriate as the time that this version of the signature was modified, but it MUST be precise to the nearest millisecond (exactly three digits after the decimal place in seconds). The modified property MUST be later than or equal to the value of the created property. If the created and modified properties are the same, then this is the first version of the signature.", + "description": "The time that this particular version of the signature was last modified. The creator can use any time it deems most appropriate as the time that this version of the signature was modified, but it MUST be precise to the nearest millisecond (exactly three digits after the decimal place in seconds). The `modified` property MUST be later than or equal to the value of the `created` property. If the `created` and `modified` properties are the same, then this is the first version of the signature.", "$comment": "Normative source: ITU-T X.590 clause 6.3.1. Cross-field invariant: `modified` MUST be greater than or equal to `created`. JSON Schema 2020-12 cannot compare two sibling property values, so this constraint is NOT enforced by this schema and MUST be validated by the consuming tool or conformance suite." }, "revoked": { "title": "Revoked Flag", - "description": "A boolean that identifies if the signature creator deems that this signature is no longer valid. The default value is false.", + "description": "A boolean that identifies if the signature creator deems that this signature is no longer valid. The default value is `false`.", "$comment": "Normative source: ITU-T X.590 clause 6.3.1", "type": "boolean", "default": false @@ -230,13 +230,13 @@ "valid_from": { "$ref": "#/$defs/timestamp", "title": "Valid From", - "description": "The time from which this signature is considered valid. If omitted, the signature is valid at all times or until the timestamp defined by valid_until. If the revoked property is true then this property MUST be ignored.", + "description": "The time from which this signature is considered valid. If omitted, the signature is valid at all times or until the timestamp defined by `valid_until`. If `revoked=true` then this property MUST be ignored.", "$comment": "Normative source: ITU-T X.590 clause 6.3.1" }, "valid_until": { "$ref": "#/$defs/timestamp", "title": "Valid Until", - "description": "The time at which this signature is no longer considered valid. If the valid_until property is omitted, then there is no constraint on the latest time for which the signature is valid. This property MUST be greater than the timestamp in the valid_from property if the valid_from property is defined. If the revoked property is true then this property MUST be ignored.", + "description": "The time at which this signature is no longer considered valid. If the `valid_until` property is omitted, then there is no constraint on the latest time for which the signature is valid. This property MUST be greater than the timestamp in the `valid_from` property if the `valid_from` property is defined. If `revoked=true` then this property MUST be ignored.", "$comment": "Normative source: ITU-T X.590 clause 6.3.1. Cross-field invariant: when `valid_from` is present, `valid_until` MUST be greater than `valid_from`. JSON Schema 2020-12 cannot compare two sibling property values, so this constraint is NOT enforced by this schema and MUST be validated by the consuming tool or conformance suite." } }, diff --git a/schema/2.0/modules/cyclonedx-party-2.0.schema.json b/schema/2.0/modules/cyclonedx-party-2.0.schema.json index 43034fd92..74e33f12b 100644 --- a/schema/2.0/modules/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-party-2.0.schema.json @@ -884,12 +884,12 @@ "country": { "type": "string", "title": "Country", - "description": "The country name or the two-letter ISO 3166-1 country code. When the isoCode property is present, the value of isoCode is authoritative." + "description": "The country name or the two-letter ISO 3166-1 country code. When the `isoCode` property is present, the value of `isoCode` is authoritative." }, "region": { "type": "string", "title": "Region", - "description": "The region or state in the country. When the isoCode property carries an ISO 3166-2 subdivision, the value of isoCode is authoritative.", + "description": "The region or state in the country. When the `isoCode` property carries an ISO 3166-2 subdivision, the value of `isoCode` is authoritative.", "examples": [ "Texas" ] }, "isoCode": { @@ -950,7 +950,7 @@ "altitude": { "type": "number", "title": "Altitude", - "description": "Altitude in meters above the reference ellipsoid identified by the datum property." + "description": "Altitude in meters above the reference ellipsoid identified by the `datum` property." }, "datum": { "type": "string", diff --git a/schema/2.0/modules/cyclonedx-patent-2.0.schema.json b/schema/2.0/modules/cyclonedx-patent-2.0.schema.json index b4f7411bf..b7a829d2c 100644 --- a/schema/2.0/modules/cyclonedx-patent-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-patent-2.0.schema.json @@ -265,7 +265,7 @@ "priorityApplication": { "type": "object", "title": "Priority Application", - "description": "The priorityApplication contains the essential data necessary to identify and reference an earlier patent filing for priority rights. In line with WIPO ST.96 guidelines, it includes the jurisdiction (office code), application number, and filing date-the three key elements that uniquely specify the priority application in a global patent context.", + "description": "The `priorityApplication` contains the essential data necessary to identify and reference an earlier patent filing for priority rights. In line with WIPO ST.96 guidelines, it includes the jurisdiction (office code), application number, and filing date-the three key elements that uniquely specify the priority application in a global patent context.", "required": ["applicationNumber", "jurisdiction", "filingDate"], "additionalProperties": false, "properties": { diff --git a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json index 5c3a62cc5..63f0e42bb 100644 --- a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json @@ -514,7 +514,7 @@ "timeframe": { "type": "string", "title": "Timeframe", - "description": "The period over which the probability or frequency is assessed, expressed as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) duration, for example P1Y for one year." + "description": "The period over which the probability or frequency is assessed, expressed as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) duration, for example `\"P1Y\"` for one year." }, "range": { "$ref": "#/$defs/estimateRange", @@ -1041,7 +1041,7 @@ "items": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType" }, - "description": "References using bom-link or `refId` to the controls that implement this response. Where a control is declared in the same document, its appliesTo property may also record the relationship." + "description": "References using bom-link or `refId` to the controls that implement this response. Where a control is declared in the same document, its `appliesTo` property may also record the relationship." }, "status": { "title": "Status", @@ -1593,7 +1593,7 @@ }, "horizon": { "type": "string", - "description": "The time horizon over which this appetite applies, expressed as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) duration, for example P1Y for one year." + "description": "The time horizon over which this appetite applies, expressed as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) duration, for example `\"P1Y\"` for one year." }, "nextReview": { "type": "string", diff --git a/schema/2.0/modules/cyclonedx-threat-2.0.schema.json b/schema/2.0/modules/cyclonedx-threat-2.0.schema.json index 34488d43d..3bc4c0dc5 100644 --- a/schema/2.0/modules/cyclonedx-threat-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-threat-2.0.schema.json @@ -8,7 +8,7 @@ "threats": { "type": "object", "title": "Threats", - "description": "Threat-modelling content, including the documented threats, the threat scenarios that realize them, the attack patterns and attack trees that describe how they are carried out, and the trust boundaries they cross. Control references throughout this model point at controls that mitigate the referencing element. Where a control is declared in the same document, its appliesTo property may also record the relationship; the reference here is intended primarily for controls defined elsewhere.", + "description": "Threat-modelling content, including the documented threats, the threat scenarios that realize them, the attack patterns and attack trees that describe how they are carried out, and the trust boundaries they cross. Control references throughout this model point at controls that mitigate the referencing element. Where a control is declared in the same document, its `appliesTo` property may also record the relationship; the reference here is intended primarily for controls defined elsewhere.", "additionalProperties": false, "properties": { "threats": { diff --git a/schema/2.0/modules/cyclonedx-vulnerability-2.0.schema.json b/schema/2.0/modules/cyclonedx-vulnerability-2.0.schema.json index c6df6fa45..75c34e068 100644 --- a/schema/2.0/modules/cyclonedx-vulnerability-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-vulnerability-2.0.schema.json @@ -213,7 +213,7 @@ "items": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType" }, - "description": "References using bom-link or `refId` to the controls that prevent or reduce the exploitability or impact of the vulnerability. Substantiates justifications such as protected_by_mitigating_control, protected_at_perimeter, and protected_at_runtime." + "description": "References using bom-link or `refId` to the controls that prevent or reduce the exploitability or impact of the vulnerability. Substantiates justifications such as `\"protected_by_mitigating_control\"`, `\"protected_at_perimeter\"`, and `\"protected_at_runtime\"`." }, "response": { "type": "array", @@ -257,7 +257,7 @@ }, "evidence": { "$ref": "#/$defs/vulnerabilityEvidence", - "description": "Evidence collected through extraction or analysis that substantiates the presence, absence, or exploitability of the vulnerability in the affected components. Evidence supports both positive determinations, such as a confirmed exploitable finding, and negative determinations, such as a \"not_affected\" conclusion, and complements the impact analysis and the proof of concept." + "description": "Evidence collected through extraction or analysis that substantiates the presence, absence, or exploitability of the vulnerability in the affected components. Evidence supports both positive determinations, such as a confirmed exploitable finding, and negative determinations, such as a `\"not_affected\"` conclusion, and complements the impact analysis and the proof of concept." }, "affects": { "type": "array", @@ -428,7 +428,7 @@ "exploitable": "The vulnerability may be directly or indirectly exploitable.", "in_triage": "The vulnerability is being investigated.", "false_positive": "The vulnerability is not specific to the component or service and was falsely identified or associated.", - "not_affected": "The component or service is not affected by the vulnerability. Justification should be specified for all \"not_affected\" cases." + "not_affected": "The component or service is not affected by the vulnerability. Justification should be specified for all `\"not_affected\"` cases." } }, "impactAnalysisJustification": { @@ -454,7 +454,7 @@ "protected_by_compiler": "Exploitability requires a compiler flag to be set/unset.", "protected_at_runtime": "Exploits are prevented at runtime.", "protected_at_perimeter": "Attacks are blocked at physical, logical, or network perimeter.", - "protected_by_mitigating_control": "Preventive measures have been implemented that reduce the likelihood or impact of the vulnerability, or both. The controls may be referenced using the mitigatingControls property." + "protected_by_mitigating_control": "Preventive measures have been implemented that reduce the likelihood or impact of the vulnerability, or both. The controls may be referenced using the `mitigatingControls` property." } }, "rating": { @@ -552,9 +552,9 @@ "rank" ], "meta:enum": { - "probability": "The likelihood of the scored outcome within the period defined by the method, expressed as a decimal from 0 to 1.", - "percentile": "The proportion of the scored population at or below this subject, expressed as a decimal from 0 to 1.", - "confidence": "The degree of certainty in the score, expressed as a decimal from 0 to 1.", + "probability": "The likelihood of the scored outcome within the period defined by the method, expressed as a decimal from `0` to `1`.", + "percentile": "The proportion of the scored population at or below this subject, expressed as a decimal from `0` to `1`.", + "confidence": "The degree of certainty in the score, expressed as a decimal from `0` to `1`.", "rank": "The position of the subject within the scored population." } }, diff --git a/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json b/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json index 7adf5188b..1cb4e64c5 100644 --- a/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json @@ -205,13 +205,13 @@ "type": "string", "minLength": 1, "title": "Scheme Version", - "description": "The version or edition of the registry that issued the identifier, for example 4.20 for CWE or 8.0 for HFACS." + "description": "The version or edition of the registry that issued the identifier, for example `\"4.20\"` for CWE or `\"8.0\"` for HFACS." }, "value": { "type": "string", "minLength": 1, "title": "Value", - "description": "The identifier value as issued by the registry, for example CWE-502." + "description": "The identifier value as issued by the registry, for example `\"CWE-502\"`." } }, "allOf": [ From 35faa063cb2c0c15384124d32ab4d7574f3a5e96 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Mon, 9 Nov 2026 17:53:57 +0100 Subject: [PATCH 12/30] revert bundled Signed-off-by: Jan Kowalleck --- schema/2.0/cyclonedx-2.0-bundled.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/cyclonedx-2.0-bundled.schema.json b/schema/2.0/cyclonedx-2.0-bundled.schema.json index 6bc2fd2ee..97683ecce 100644 --- a/schema/2.0/cyclonedx-2.0-bundled.schema.json +++ b/schema/2.0/cyclonedx-2.0-bundled.schema.json @@ -4922,7 +4922,7 @@ "extensibleProperties": { "type": "object", "title": "Extensible Properties", - "$comment": "This is a mixin. It intentionally does NOT restrict additional/unevaluated properties itself; schemas composing it via `allOf` are expected to close themselves with `unevaluatedProperties=false` so that both their own defined properties and these patternProperties remain usable.", + "$comment": "This is a mixin. It intentionally does NOT restrict additional/unevaluated properties itself; schemas composing it via `allOf` are expected to close themselves with `unevaluatedProperties: false` so that both their own defined properties and these patternProperties remain usable.", "patternProperties": { "^ext:[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}:.+$": { "description": "CycloneDX supports a structured and namespace-aware mechanism for extensibility through the use of extensible properties. This mechanism enables organizations, ecosystems, and tool vendors to safely introduce custom properties without conflicting with the core schema or other extensions.\n\nExtensible properties are defined as a JSON object whose keys must conform to a strict pattern that resembles a reverse domain name structure, prefixed with ext:. This pattern provides a namespacing convention that aligns with well-established practices in other structured formats (e.g., XML namespaces).\n\nValues that are objects must declare the schema they conform to via `$schema`. This requirement applies recursively to objects contained in arrays, at any nesting depth.", From 9532006b781d86f86573498145a4eaa3b7e23b63 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Tue, 10 Nov 2026 10:41:09 +0100 Subject: [PATCH 13/30] docs Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-behavior-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-common-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-component-2.0.schema.json | 4 ++-- schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json | 4 ++-- schema/2.0/modules/cyclonedx-formulation-2.0.schema.json | 4 ++-- schema/2.0/modules/cyclonedx-license-2.0.schema.json | 4 ++-- schema/2.0/modules/cyclonedx-risk-2.0.schema.json | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json b/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json index 8f7643407..116d37e76 100644 --- a/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json @@ -282,7 +282,7 @@ "type": "integer", "title": "Ordinal", "minimum": 1, - "description": "Position within a sequential graph. Required when the graph's `ordering=\"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", diff --git a/schema/2.0/modules/cyclonedx-common-2.0.schema.json b/schema/2.0/modules/cyclonedx-common-2.0.schema.json index a96c8913f..829130831 100644 --- a/schema/2.0/modules/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-common-2.0.schema.json @@ -14,7 +14,7 @@ "refLinkType": { "description": "Descriptor for an element identified by the attribute `refId` in the same BOM document.\nIn contrast to `bomLinkElementType`.", "allOf": [{ "$ref": "#/$defs/refIdType" }], - "$comment": "value-range is same as 'refIdType'" + "$comment": "value-range is same as `refIdType`" }, "bomLinkDocumentType": { "title": "BOM-Link Document", diff --git a/schema/2.0/modules/cyclonedx-component-2.0.schema.json b/schema/2.0/modules/cyclonedx-component-2.0.schema.json index adc0b7557..c8c10f85b 100644 --- a/schema/2.0/modules/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-component-2.0.schema.json @@ -414,7 +414,7 @@ }, "componentEntry": { "title": "Component Entry", - "description": "An entry in a components array. A concrete component, a reference to a component declared elsewhere, or a component-choice wrapper that expresses a conditional or alternate relationship between two or more entries. An entry with a `ref` property is a reference; an entry whose `type=\"component-choice\"` is a choice; any other entry is a component.", + "description": "An entry in a components array. A concrete component, a reference to a component declared elsewhere, or a component-choice wrapper that expresses a conditional or alternate relationship between two or more entries. An entry with a `ref` property is a reference; an entry with `type=\"component-choice\"` is a choice; any other entry is a component.", "oneOf": [ { "$ref": "#/$defs/component" }, { "$ref": "#/$defs/componentReference" }, @@ -837,7 +837,7 @@ "configurationRef": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", "title": "Configuration Reference", - "description": "The `refId` of the configuration that determines this component's configuration. Typically points to a component with `type=\"data\"` and `data.type=\"configuration\"`." + "description": "The `refId` of the configuration that determines this component's configuration. Typically points to a component with `type=\"data\"` whose `data` entry has `type=\"configuration\"`." }, "changeMechanism": { "type": "array", diff --git a/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json b/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json index e70b91583..8b5f6511f 100644 --- a/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json @@ -79,7 +79,7 @@ "algorithmFamily": { "$ref": "../../cryptography-defs.schema.json#/definitions/algorithmFamiliesEnum", "title": "Algorithm Family", - "description": "A valid algorithm family identifier. If specified, this value shall be one of the enumeration of valid algorithm Family identifiers defined in the \"cryptography-defs\" schema.", + "description": "A valid algorithm family identifier. If specified, this value shall be one of the enumeration of valid algorithm Family identifiers defined in the `cryptography-defs.schema.json` subschema.", "examples": [ "3DES", "Blowfish", @@ -94,7 +94,7 @@ "ellipticCurve": { "$ref": "../../cryptography-defs.schema.json#/definitions/ellipticCurvesEnum", "title": "Elliptic Curve", - "description": "The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. If specified, this value shall be one of the enumeration of valid elliptic curves identifiers defined in the \"cryptography-defs\" schema." + "description": "The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. If specified, this value shall be one of the enumeration of valid elliptic curves identifiers defined in the `cryptography-defs.schema.json` subschema." }, "executionEnvironment": { "title": "Execution Environment", diff --git a/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json b/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json index 4039ea92c..2dad92772 100644 --- a/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json @@ -675,7 +675,7 @@ "properties": { "source": { "title": "Source", - "description": "A reference to the component or service that provided the input to the task (e.g., reference to a service with `flow=\"inbound\"`)", + "description": "A reference to the component or service that provided the input to the task (e.g., reference to a service that is the `source` of a blueprint flow)", "examples": [ "source code repository", "database" @@ -761,7 +761,7 @@ }, "target": { "title": "Target", - "description": "Component or service that received the output from the task (e.g., reference to an artifactory service with `flow=\"outbound\"`)", + "description": "Component or service that received the output from the task (e.g., reference to an artifactory service that is the `destination` of a blueprint flow)", "examples": ["a log file described as an `externalReference` within its target domain."], "$ref": "#/$defs/resourceReferenceChoice" }, diff --git a/schema/2.0/modules/cyclonedx-license-2.0.schema.json b/schema/2.0/modules/cyclonedx-license-2.0.schema.json index 22b753484..6242a35d7 100644 --- a/schema/2.0/modules/cyclonedx-license-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-license-2.0.schema.json @@ -111,7 +111,7 @@ "url": { "type": "string", "title": "License URL", - "description": "The URL to the license file. If specified, a `externalReference` with `type=\"license\"` should also be specified for completeness", + "description": "The URL to the license file. If specified, an `externalReferences` entry with `type=\"license\"` should also be specified for completeness", "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt"], "format": "iri-reference" }, @@ -168,7 +168,7 @@ "url": { "type": "string", "title": "License URL", - "description": "The URL to the license file. If specified, a `externalReference` with `type=\"license\"` should also be specified for completeness", + "description": "The URL to the license file. If specified, an `externalReferences` entry with `type=\"license\"` should also be specified for completeness", "examples": [ "https://www.apache.org/licenses/LICENSE-2.0.txt" ], diff --git a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json index d89ff2bca..237c3f963 100644 --- a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json @@ -400,7 +400,7 @@ "rating": { "type": "object", "title": "Rating", - "description": "A methodology-neutral assessment of risk along likelihood and impact, with an overall score. The same shape expresses inherent, residual, and target risk so reductions can be compared. A rating can be qualitative (a `likelihood.level`), semi-quantitative (a numeric `score` on a bounded scale), or quantitative (for example a probable monetary loss under [FAIR](https://www.fairinstitute.org/)). For a catalogue of assessment techniques, see [IEC 31010](https://www.iso.org/standard/72140.html).", + "description": "A methodology-neutral assessment of risk along likelihood and impact, with an overall score. The same shape expresses inherent, residual, and target risk so reductions can be compared. A rating can be qualitative (a `score.level`), semi-quantitative (a numeric `score` on a bounded scale), or quantitative (for example a probable monetary loss under [FAIR](https://www.fairinstitute.org/)). For a catalogue of assessment techniques, see [IEC 31010](https://www.iso.org/standard/72140.html).", "additionalProperties": false, "properties": { "likelihood": { From 809269a0435c464ece99cc8d9dd0e130cc5880a9 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Tue, 10 Nov 2026 11:44:30 +0100 Subject: [PATCH 14/30] docs Signed-off-by: Jan Kowalleck --- .../2.0/modules/cyclonedx-ai-ml-2.0.schema.json | 2 +- .../2.0/modules/cyclonedx-common-2.0.schema.json | 16 ++++++++-------- .../cyclonedx-cryptography-2.0.schema.json | 2 +- .../cyclonedx-formulation-2.0.schema.json | 4 ++-- .../cyclonedx-jss_X590_2023_10-2.0.schema.json | 6 +++--- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json b/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json index 522fca4df..43347c007 100644 --- a/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-ai-ml-2.0.schema.json @@ -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": { diff --git a/schema/2.0/modules/cyclonedx-common-2.0.schema.json b/schema/2.0/modules/cyclonedx-common-2.0.schema.json index 829130831..017fe788d 100644 --- a/schema/2.0/modules/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-common-2.0.schema.json @@ -299,7 +299,7 @@ "patent-family": "References information about a patent family which may be defined in human-readable documents or in machine-readable formats such as CycloneDX or ST.96. A patent family is a group of related patent applications or granted patents that cover the same or similar invention. For detailed patent family information or to reference the information provided directly by patent offices, it is recommended to leverage standards from the World Intellectual Property Organization (WIPO) such as [ST.96](https://www.wipo.int/standards/en/st96).", "patent-assertion" : "References assertions made regarding patents associated with a component or service. Assertions distinguish between ownership, licensing, and other relevant interactions with patents.", "citation": "A reference to external citations applicable to the object identified in a CycloneDX artifact or payload or the CycloneDX artifact or payload itself. When used with a BOM-Link, this allows offloading citations into a separate CycloneDX artifacts or payloads.", - "swid-tag": "A Software Identification (SWID) tag document conforming to ISO/IEC 19770-2. The reference resolves to the XML SoftwareIdentity document itself, including all of its metadata (entities, evidence, payload, links, and meta elements). This is distinct from the `\"swid\"` identifier scheme, which carries only the tagId of a SWID tag.", + "swid-tag": "A Software Identification (SWID) tag document conforming to ISO/IEC 19770-2. The reference resolves to the XML SoftwareIdentity document itself, including all of its metadata (entities, evidence, payload, links, and meta elements). This is distinct from the `\"swid\"` identifier scheme, which carries only the `tagId` of a SWID tag.", "gs1-digital-link": "A [GS1 Digital Link URI](https://ref.gs1.org/standards/digital-link/uri-syntax/) that connects the component's GS1 identification key, such as a GTIN, to online sources of information, including product data, safety documentation, digital product passports, and recall status. The URI may include key qualifiers, such as a batch or serial number, enabling identification at the class, batch, or individual item level. Component identity shall be derived from the component's identifiers, not from keys embedded in this URI.", "other": "Use this if no other types accurately describe the purpose of the external reference." } @@ -607,10 +607,10 @@ "extensibleProperties": { "type": "object", "title": "Extensible Properties", - "$comment": "This is a mixin. It intentionally does NOT restrict additional/unevaluated properties itself; schemas composing it via `allOf` are expected to close themselves with `unevaluatedProperties=false` so that both their own defined properties and these patternProperties remain usable.", + "$comment": "This is a mixin. It intentionally does NOT restrict additional/unevaluated properties itself; schemas composing it via `allOf` are expected to close themselves with `\"unevaluatedProperties\": false` so that both their own defined properties and these patternProperties remain usable.", "patternProperties": { "^ext:[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}:.+$": { - "description": "CycloneDX supports a structured and namespace-aware mechanism for extensibility through the use of extensible properties. This mechanism enables organizations, ecosystems, and tool vendors to safely introduce custom properties without conflicting with the core schema or other extensions.\n\nExtensible properties are defined as a JSON object whose keys must conform to a strict pattern that resembles a reverse domain name structure, prefixed with ext:. This pattern provides a namespacing convention that aligns with well-established practices in other structured formats (e.g., XML namespaces).\n\nValues that are objects must declare the schema they conform to via `$schema`. This requirement applies recursively to objects contained in arrays, at any nesting depth.", + "description": "CycloneDX supports a structured and namespace-aware mechanism for extensibility through the use of extensible properties. This mechanism enables organizations, ecosystems, and tool vendors to safely introduce custom properties without conflicting with the core schema or other extensions.\n\nExtensible properties are defined as a JSON object whose keys must conform to a strict pattern that resembles a reverse domain name structure, prefixed with `\"ext:\"`. This pattern provides a namespacing convention that aligns with well-established practices in other structured formats (e.g., XML namespaces).\n\nValues that are objects must declare the schema they conform to via `$schema`. This requirement applies recursively to objects contained in arrays, at any nesting depth.", "examples": [ "ext::", "ext:example.org:myExtension" @@ -622,7 +622,7 @@ "propertyObject": { "type": "object", "title": "Extensible Property Object", - "$comment": "Internal helper for extensibleProperties. Not part of the public schema API — do not reference externally; may change without notice.\n\nThis is a mixin.", + "$comment": "Internal helper for `extensibleProperties`. Not part of the public schema API — do not reference externally; may change without notice.\n\nThis is a mixin.", "required": ["$schema"], "properties": { "$schema": { @@ -633,7 +633,7 @@ }, "propertyValue": { "title": "Extensible Property Value", - "$comment": "Internal helper for extensibleProperties. Not part of the public schema API — do not reference externally; may change without notice.\nRecursive: objects must declare a `$schema`, arrays may nest arbitrarily deep with the same rule applied to every item, all other values are plain scalars.", + "$comment": "Internal helper for `extensibleProperties`. Not part of the public schema API — do not reference externally; may change without notice.\nRecursive: objects must declare a `$schema`, arrays may nest arbitrarily deep with the same rule applied to every item, all other values are plain scalars.", "if": { "type": "object" }, @@ -660,7 +660,7 @@ "baseObject": { "type": "object", "description": "Base object for all CycloneDX entities. Automatically includes support for extensible properties.", - "$comment": "This is a mixin. It intentionally does NOT set `unevaluatedProperties=false` — that keyword cannot see properties defined by schemas composing this one via `allOf`, and would reject them. Concrete (leaf) schemas composing this mixin must close themselves with `unevaluatedProperties=false`.", + "$comment": "This is a mixin. It intentionally does NOT set `\"unevaluatedProperties\": false` — that keyword cannot see properties defined by schemas composing this one via `allOf`, and would reject them. Concrete (leaf) schemas composing this mixin must close themselves with `\"unevaluatedProperties\": false`.", "allOf": [ { "$ref": "#/$defs/extensibleProperties" } ], @@ -1026,7 +1026,7 @@ "measure": { "type": "object", "title": "Measure", - "description": "A quantity expressed as a numeric value and a unit. Contexts that use this definition may constrain the permitted units, as the energy and carbon dioxide equivalent measures do. Dimensionless quantities and counts use the unit one, written as 1.", + "description": "A quantity expressed as a numeric value and a unit. Contexts that use this definition may constrain the permitted units, as the energy and carbon dioxide equivalent measures do. Dimensionless quantities and counts use the unit one, written as `\"1\"`.", "additionalProperties": false, "required": ["value", "unit"], "properties": { @@ -1147,7 +1147,7 @@ "enum": ["ucum", "unece-rec20", "qudt"], "meta:enum": { "ucum": "The [Unified Code for Units of Measure](https://ucum.org/), whose codes are case-sensitive strings such as kg, By, or {token}/s.", - "unece-rec20": "[UN/ECE Recommendation 20](https://unece.org/trade/uncefact/cl-recommendations), whose codes are two or three character strings such as KWH or C26.", + "unece-rec20": "[UN/ECE Recommendation 20](https://unece.org/trade/uncefact/cl-recommendations), whose codes are two or three character strings such as `\"KWH\"` or `\"C26\"`.", "qudt": "The [QUDT](https://qudt.org/) unit vocabulary, whose codes are the unit identifiers in IRI form." } }, diff --git a/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json b/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json index 8b5f6511f..344cb8975 100644 --- a/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json @@ -38,7 +38,7 @@ "properties": { "primitive": { "title": "primitive", - "description": "Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (`\"drbg\"`, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (`\"mac\"`, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (`\"pke\"`, e.g. RSA), extended output functions (`\"xof\"`, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (`\"ae\"`, e.g. AES-GCM) and the combination of multiple algorithms (`\"combiner\"`, e.g. SP800-56Cr2).", + "description": "Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (`\"drbg\"`, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (`\"mac\"`, e.g. HMAC-SHA-256), blockciphers (`\"block-cipher\"`, e.g. AES), streamciphers (`\"stream-cipher\"`, e.g. Salsa20), signatures (`\"signature\"`, e.g. ECDSA), hash functions (`\"hash\"`, e.g. SHA-256), public-key encryption schemes (`\"pke\"`, e.g. RSA), extended output functions (`\"xof\"`, e.g. SHAKE256), key derivation functions (`\"kdf\"`, e.g. pbkdf2), key agreement algorithms (`\"key-agree\"`, e.g. ECDH), key encapsulation mechanisms (`\"kem\"`, e.g. ML-KEM), authenticated encryption (`\"ae\"`, e.g. AES-GCM) and the combination of multiple algorithms (`\"combiner\"`, e.g. SP800-56Cr2).", "enum": [ "drbg", "mac", diff --git a/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json b/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json index 2dad92772..a24a747e4 100644 --- a/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json @@ -41,7 +41,7 @@ "workflow": { "title": "Workflow", "description": "A specialized orchestration task.", - "$comment": "Workflow are as task themselves and can trigger other workflow tasks. These relationships can be modeled in the taskDependencies graph.", + "$comment": "Workflow are as task themselves and can trigger other workflow tasks. These relationships can be modeled in the `taskDependencies` graph.", "type": "object", "required": [ "refId", @@ -793,7 +793,7 @@ "resourceReferenceChoice": { "title": "Resource reference choice", "description": "A reference to a locally defined resource (e.g., a `refId`) or an externally accessible resource.", - "$comment": "Enables reference to a resource that participates in a workflow; using either internal (refId) or external (externalReference) types.", + "$comment": "Enables reference to a resource that participates in a workflow; using either internal (`refId`) or external (`externalReference`) types.", "type": "object", "additionalProperties": false, "properties": { diff --git a/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json b/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json index 542dcdafb..14b3f6822 100644 --- a/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json @@ -111,7 +111,7 @@ }, "publicCertChain": { "title": "Public Certificate Chain", - "description": "This property contains a public key certificate for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.7 of [IETF RFC 7517] as quoted here. This property \"contains a chain (X.509 certificate chain) of one or more PKIX certificates [IETF RFC 5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (section 4 of [IETF RFC 4648] – not base64URL.encoded) DER [b-ITU-T X.690] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. This MAY be followed by additional certificates, with each subsequent certificate being the one used to certify the previous one. The key in the first certificate MUST match the public key.\" This property is called \"x5c\" in section 4.7 of [IETF RFC 7517].", + "description": "This property contains a public key certificate for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.7 of [IETF RFC 7517] as quoted here. This property \"contains a chain (X.509 certificate chain) of one or more PKIX certificates [IETF RFC 5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (section 4 of [IETF RFC 4648] – not base64URL.encoded) DER [b-ITU-T X.690] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. This MAY be followed by additional certificates, with each subsequent certificate being the one used to certify the previous one. The key in the first certificate MUST match the public key.\" This property is called `\"x5c\"` in section 4.7 of [IETF RFC 7517].", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "array", "items": { @@ -122,7 +122,7 @@ }, "certUrl": { "title": "Certificate URL", - "description": "This property contains a uniform resource identifier (URI) [IETF RFC 3986] that refers to a resource for an X.509 public key certificate or certificate chain [IETF RFC 5280] for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.6 of [IETF RFC 7517] as quoted here. \"The identified resource MUST provide a representation of the certificate or certificate chain that conforms to RFC 5280 [IETF RFC 5280] in PEM-encoded form, with each certificate delimited as specified in section 6.1 of RFC 4945 [IETF RFC 4945]. The key in the first certificate MUST match the public key. The protocol used to acquire the resource MUST provide integrity protection; an HTTP GET request to retrieve the certificate MUST use TLS [IETF RFC 2818] [IETF RFC 5246]; the identity of the server MUST be validated, as per section 6 of RFC 6125 [IETF RFC 6125].\" This property is called \"x5u\" in section 4.6 of [IETF RFC 7517].", + "description": "This property contains a uniform resource identifier (URI) [IETF RFC 3986] that refers to a resource for an X.509 public key certificate or certificate chain [IETF RFC 5280] for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.6 of [IETF RFC 7517] as quoted here. \"The identified resource MUST provide a representation of the certificate or certificate chain that conforms to RFC 5280 [IETF RFC 5280] in PEM-encoded form, with each certificate delimited as specified in section 6.1 of RFC 4945 [IETF RFC 4945]. The key in the first certificate MUST match the public key. The protocol used to acquire the resource MUST provide integrity protection; an HTTP GET request to retrieve the certificate MUST use TLS [IETF RFC 2818] [IETF RFC 5246]; the identity of the server MUST be validated, as per section 6 of RFC 6125 [IETF RFC 6125].\" This property is called `\"x5u\"` in section 4.6 of [IETF RFC 7517].", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "string", "format": "uri", @@ -133,7 +133,7 @@ }, "thumbprint": { "title": "Certificate Thumbprint", - "description": "This property contains a fingerprint of a public key or public key certificate for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.9 of [IETF RFC 7517] as quoted here. This property \"is a base64URL.encoded SHA-256 thumbprint (a.k.a. digest, X.509 certificate SHA-256 thumbprint) of the DER encoding of an X.509 certificate [IETF RFC 5280]. Note that certificate thumbprints are also sometimes known as certificate fingerprints. The key in the certificate MUST match the public key.\" This property is called \"x5t#S256\" in section 4.9 of [IETF RFC 7517].", + "description": "This property contains a fingerprint of a public key or public key certificate for the algorithm selected in the `algorithm` property and MUST follow the requirements defined in section 4.9 of [IETF RFC 7517] as quoted here. This property \"is a base64URL.encoded SHA-256 thumbprint (a.k.a. digest, X.509 certificate SHA-256 thumbprint) of the DER encoding of an X.509 certificate [IETF RFC 5280]. Note that certificate thumbprints are also sometimes known as certificate fingerprints. The key in the certificate MUST match the public key.\" This property is called `\"x5t#S256\"` in section 4.9 of [IETF RFC 7517].", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$", From f689c3c8736a65656c013e196732b2cfc29ec089 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Tue, 10 Nov 2026 12:08:56 +0100 Subject: [PATCH 15/30] docs Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-common-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-component-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-data-2.0.schema.json | 2 +- .../2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json | 6 +++--- schema/2.0/modules/cyclonedx-party-2.0.schema.json | 6 +++--- schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json b/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json index 2fe81916b..1c0abaa94 100644 --- a/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json @@ -2049,7 +2049,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" diff --git a/schema/2.0/modules/cyclonedx-common-2.0.schema.json b/schema/2.0/modules/cyclonedx-common-2.0.schema.json index 017fe788d..c8f069c86 100644 --- a/schema/2.0/modules/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-common-2.0.schema.json @@ -258,7 +258,7 @@ "chat": "Real-time chat platform", "documentation": "Documentation, guides, or how-to instructions", "support": "Community or commercial support", - "source-distribution": "The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type.", + "source-distribution": "The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The `\"source-distribution\"` type complements use of the version control (`\"vcs\"`) type.", "distribution": "Direct or repository download location", "distribution-intake": "The location where a component was published to. This is often the same as `\"distribution\"` but may also include specialized publishing processes that act as an intermediary.", "license": "The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness.", diff --git a/schema/2.0/modules/cyclonedx-component-2.0.schema.json b/schema/2.0/modules/cyclonedx-component-2.0.schema.json index c8c10f85b..144956a53 100644 --- a/schema/2.0/modules/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-component-2.0.schema.json @@ -414,7 +414,7 @@ }, "componentEntry": { "title": "Component Entry", - "description": "An entry in a components array. A concrete component, a reference to a component declared elsewhere, or a component-choice wrapper that expresses a conditional or alternate relationship between two or more entries. An entry with a `ref` property is a reference; an entry with `type=\"component-choice\"` is a choice; any other entry is a component.", + "description": "An entry in a `components` array. A concrete component, a reference to a component declared elsewhere, or a component-choice wrapper that expresses a conditional or alternate relationship between two or more entries. An entry with a `ref` property is a reference; an entry with `type=\"component-choice\"` is a choice; any other entry is a component.", "oneOf": [ { "$ref": "#/$defs/component" }, { "$ref": "#/$defs/componentReference" }, diff --git a/schema/2.0/modules/cyclonedx-data-2.0.schema.json b/schema/2.0/modules/cyclonedx-data-2.0.schema.json index 57eba7320..cc8011aea 100644 --- a/schema/2.0/modules/cyclonedx-data-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-data-2.0.schema.json @@ -865,7 +865,7 @@ "dataGovernance": { "type": "array", "title": "Data Governance", - "description": "Parties responsible for the data throughout its lifecycle. Each entry is either an inline party object or a reference to a previously declared party. The party's `roles` carry the governance relationship (`\"owner\"` for ownership and risk accountability, `\"steward\"` for content and business rules, `\"custodian\"` for safe custody, transport, and storage, `\"data-controller\"`, `\"data-processor\"`, `\"data-recipient\"`, or a custom role). Multiple parties may share the same role; preference among them is expressed via `role.order`.", + "description": "Parties responsible for the data throughout its lifecycle. Each entry is either an inline party object or a reference to a previously declared party. The party's `roles` carry the governance relationship (`\"owner\"` for ownership and risk accountability, `\"steward\"` for content and business rules, `\"custodian\"` for safe custody, transport, and storage, `\"data-controller\"`, `\"data-processor\"`, `\"data-recipient\"`, 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" diff --git a/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json b/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json index 14b3f6822..7734af3d5 100644 --- a/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-jss_X590_2023_10-2.0.schema.json @@ -167,7 +167,7 @@ }, "value": { "title": "Signature Value", - "description": "A base64URL.encoded signature that was created using the signature algorithm defined in the algorithm property and a key. In pseudo code it is defined as: base64URL.encode(sign(algorithm, key, hash(jcs()))).", + "description": "A base64URL.encoded signature that was created using the signature algorithm defined in the `algorithm` property and a key. In pseudo code it is defined as: `base64URL.encode(sign(algorithm, key, hash(jcs())))`.", "$comment": "Normative source: ITU-T X.590 clause 6.2.1", "type": "string", "pattern": "^[A-Za-z0-9_-]+={0,2}$" @@ -180,7 +180,7 @@ }, "type": { "title": "Type Indicator", - "description": "The value of this property MUST be jss.", + "description": "The value of this property MUST be `\"jss\"`.", "$comment": "Normative source: ITU-T X.590 clause 6.3.1", "const": "jss" }, @@ -264,7 +264,7 @@ } ], "unevaluatedProperties": true, - "$comment": "This is a mixin: ITU-T X.590 clause 6.2 explicitly states that implementers MAY add additional properties to satisfy meta-data requirements for their application. The clause 6.3 properties (type, id, related_to, etc.) are themselves defined as non-exhaustive examples of such extensions." + "$comment": "This is a mixin: ITU-T X.590 clause 6.2 explicitly states that implementers MAY add additional properties to satisfy meta-data requirements for their application. The clause 6.3 properties (`type`, `id`, `related_to`, etc.) are themselves defined as non-exhaustive examples of such extensions." }, "signatures": { "title": "Signatures Array", diff --git a/schema/2.0/modules/cyclonedx-party-2.0.schema.json b/schema/2.0/modules/cyclonedx-party-2.0.schema.json index c3fb1d98c..b7f9ca893 100644 --- a/schema/2.0/modules/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-party-2.0.schema.json @@ -8,7 +8,7 @@ "party": { "type": "object", "title": "Party", - "description": "Identifies an organization, individual, system, or abstract archetype that participates in supplying, producing, attesting, operating, owning, regulating, or otherwise relating to the subject. Each party plays one or more named roles. Roles may carry preference order (`role.order`) to express primary, alternate, and secondary rankings among parties sharing the same role.\n\nExactly one identity sub-shape (`organization`, `person`, `system`, or `persona`) shall be present. Optional sub-objects layer inter-party relationships and standard extension data.", + "description": "Identifies an organization, individual, system, or abstract archetype that participates in supplying, producing, attesting, operating, owning, regulating, or otherwise relating to the subject. Each party plays one or more named roles. Roles may carry preference order (`roles[].order`) to express primary, alternate, and secondary rankings among parties sharing the same role.\n\nExactly one identity sub-shape (`organization`, `person`, `system`, or `persona`) shall be present. Optional sub-objects layer inter-party relationships and standard extension data.", "required": [ "roles" ], "additionalProperties": false, "properties": { @@ -73,7 +73,7 @@ "parties": { "type": "array", "title": "Parties", - "description": "Parties associated with the subject. Each item identifies an organization, individual, system, or abstract archetype playing one or more named roles such as manufacturer, supplier, author, integrator, quality-control, or any custom role. The same party can hold multiple roles, each independently ranked via `role.order` to express preference (for example, primary supplier with order `1` and alternate supplier with order `2`). Items may be inline party objects or references to parties declared elsewhere.", + "description": "Parties associated with the subject. Each item identifies an organization, individual, system, or abstract archetype playing one or more named roles such as `\"manufacturer\"`, `\"supplier\"`, `\"author\"`, `\"integrator\"`, `\"quality-control\"`, or any custom role. The same party can hold multiple roles, each independently ranked via `roles[].order` to express preference (for example, primary supplier with order `1` and alternate supplier with order `2`). Items may be inline party objects or references to parties declared elsewhere.", "items": { "$ref": "#/$defs/partyChoice" } }, "partyChoice": { @@ -736,7 +736,7 @@ "partyRelations": { "type": "object", "title": "Party Relations", - "description": "Links from this party to other parties. Captures hierarchical, organizational, and delegation relationships. Order ranking is on the role itself (`role.order`), not here.", + "description": "Links from this party to other parties. Captures hierarchical, organizational, and delegation relationships. Order ranking is on the role itself (`roles[].order`), not here.", "additionalProperties": false, "properties": { "parent": { diff --git a/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json b/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json index 9f935acf3..ee769ed39 100644 --- a/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json @@ -92,7 +92,7 @@ "pre-release", "internal" ], - "description": "The software versioning type. It is recommended that the release type use one of `\"major\"`, `\"minor\"`, `\"patch\"`, `\"pre-release\"`, or `\"internal\"`. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it." + "description": "The software versioning type. It is recommended that the release type use one of `\"major\"`, `\"minor\"`, `\"patch\"`, `\"pre-release\"`, or `\"internal\"`. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* `\"major\"` = A major release may contain significant changes or may introduce breaking changes.\n* `\"minor\"` = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* `\"patch\"` = Patch releases are typically unplanned and may resolve defects or important security issues.\n* `\"pre-release\"` = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* `\"internal\"` = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it." }, "note": { "type": "object", From 2497bb42735c8a3fe6ae725b3e7ddcb49dcdff65 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 13:18:51 +0100 Subject: [PATCH 16/30] docs Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-component-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-component-2.0.schema.json b/schema/2.0/modules/cyclonedx-component-2.0.schema.json index 3fae082dd..e5ee0bf35 100644 --- a/schema/2.0/modules/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-component-2.0.schema.json @@ -343,7 +343,7 @@ } }, { - "description": "Requirement: 'versionRange' shall not be present when `isExternal=false`.", + "description": "Requirement: `versionRange` shall not be present when `isExternal=false`.", "if": { "properties": { "isExternal": { "const": false } } }, diff --git a/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json b/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json index 0b453ee9c..ee769ed39 100644 --- a/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json @@ -106,7 +106,7 @@ "locale": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/locale", "title": "Locale", - "description": "The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: `\"en\"`, `\"en-US\"`, `\"fr\"` and `\"fr-CA\"`." + "description": "The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: `\"en\"`, `\"en-US\"`, `\"fr\"` and `\"fr-CA\"`." }, "text": { "title": "Release note content", From 2e96e7b319203380b77422c5e8dc07d86ce5226d Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 14:13:03 +0100 Subject: [PATCH 17/30] examples Signed-off-by: Jan Kowalleck --- .../modules/cyclonedx-common-2.0.schema.json | 3 +- .../cyclonedx-component-2.0.schema.json | 8 ++--- .../modules/cyclonedx-data-2.0.schema.json | 2 +- .../cyclonedx-evidence-2.0.schema.json | 30 +++++++++++++++++-- .../modules/cyclonedx-patent-2.0.schema.json | 8 +++-- .../cyclonedx-release-notes-2.0.schema.json | 3 +- .../modules/cyclonedx-risk-2.0.schema.json | 6 ++-- .../cyclonedx-weakness-2.0.schema.json | 6 ++-- 8 files changed, 50 insertions(+), 16 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-common-2.0.schema.json b/schema/2.0/modules/cyclonedx-common-2.0.schema.json index e20ff2351..dc5066b70 100644 --- a/schema/2.0/modules/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-common-2.0.schema.json @@ -1016,7 +1016,8 @@ "type": "string", "pattern": "^([a-z]{2})(-[A-Z]{2})?$", "title": "Locale", - "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code shall be lower case. If the country code is specified, the country code shall be upper case. The language code and country code shall be separated by a minus sign. Examples: `\"en\"`, `\"en-US\"`, `\"fr\"`, `\"fr-CA\"`." + "description": "Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code shall be lower case. If the country code is specified, the country code shall be upper case. The language code and country code shall be separated by a minus sign.", + "examples": ["en", "en-US", "fr", "fr-CA"] }, "signatures": { "$ref": "cyclonedx-jss_X590_2023_10-2.0.schema.json#/$defs/signatures", diff --git a/schema/2.0/modules/cyclonedx-component-2.0.schema.json b/schema/2.0/modules/cyclonedx-component-2.0.schema.json index e5ee0bf35..0b29f2ec5 100644 --- a/schema/2.0/modules/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-component-2.0.schema.json @@ -80,14 +80,14 @@ "group": { "type": "string", "title": "Component Group", - "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.", - "examples": ["com.acme"] + "description": "The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided.", + "examples": ["com.acme", "apache", "org.apache.commons", "apache.org"] }, "name": { "type": "string", "title": "Component Name", - "description": "The name of the component. This will often be a shortened, single name of the component. Examples: `\"commons-lang3\"` and `\"jquery\"`.", - "examples": ["tomcat-catalina"] + "description": "The name of the component. This will often be a shortened, single name of the component.", + "examples": ["tomcat-catalina", "commons-lang3", "jquery"] }, "version": { "$ref": "#/$defs/version", diff --git a/schema/2.0/modules/cyclonedx-data-2.0.schema.json b/schema/2.0/modules/cyclonedx-data-2.0.schema.json index cc8011aea..3c7a2d52e 100644 --- a/schema/2.0/modules/cyclonedx-data-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-data-2.0.schema.json @@ -343,7 +343,7 @@ "mediaType": { "type": "string", "title": "Media Type", - "description": "Media type of the schema, for example `\"application/schema+json\"`, `\"application/xml\"`, or `\"application/vnd.apache.avro+json\"`.", + "description": "Media type of the schema.", "examples": [ "application/schema+json", "application/xml", diff --git a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json index 4ed8c16ef..763318f64 100644 --- a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json @@ -22,7 +22,13 @@ "location": { "type": "string", "title": "Location", - "description": "The location or path at which the subject was found, for example a file path, a URL, or a package coordinate." + "description": "The location or path at which the subject was found, for example a file path, a URL, or a package coordinate.", + "examples": [ + "src/authentication/login.py", + "https://example.com/login", + "npm:lodash@4.17.21", + "docker.io/library/nginx:1.25" + ] }, "line": { "type": "integer", @@ -416,7 +422,19 @@ "role": { "$ref": "cyclonedx-party-2.0.schema.json#/$defs/role", "title": "Role", - "description": "The role or vantage in which the party was involved, for example `\"supplier\"`, `\"manufacturer\"`, `\"distributor\"`, `\"operator\"`, `\"customer\"`, `\"end-user\"`, `\"asserter\"`, `\"auditor\"`, `\"reviewer\"`, or `\"researcher\"`." + "description": "The role or vantage in which the party was involved.", + "examples": [ + "supplier", + "manufacturer", + "distributor", + "operator", + "customer", + "end-user", + "asserter", + "auditor", + "reviewer", + "researcher" + ] } } }, @@ -519,7 +537,13 @@ "name": { "type": "string", "title": "Name", - "description": "The name or label of the data, for example `\"attack prompt\"`, `\"model response\"`, `\"HTTP request\"`, or `\"scanner report\"`." + "description": "The name or label of the data.", + "examples": [ + "attack prompt", + "model response", + "HTTP request", + "scanner report" + ] }, "ref": { "anyOf": [ diff --git a/schema/2.0/modules/cyclonedx-patent-2.0.schema.json b/schema/2.0/modules/cyclonedx-patent-2.0.schema.json index 9e50bf754..3428da545 100644 --- a/schema/2.0/modules/cyclonedx-patent-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-patent-2.0.schema.json @@ -48,7 +48,11 @@ "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9\\-/.()\\s]{0,28}[A-Za-z0-9]$", "title": "Patent Publication Number", - "description": "This is the number assigned to a patent application once it is published. Patent applications are generally published 18 months after filing (unless an applicant requests non-publication). This number is distinct from the application number. \n\nPurpose: Identifies the publicly available version of the application. \n\nFormat: Varies by jurisdiction, often similar to application numbers but includes an additional suffix indicating publication. \n\nExample:\n - US: `\"US20240000123A1\"` (indicates the first publication of application US20240000123) \n - Europe: `\"EP23123456A1\"` (first publication of European application EP23123456). \n\nWIPO ST.96 v8.0: \n - Publication Number field: ." + "description": "This is the number assigned to a patent application once it is published. Patent applications are generally published 18 months after filing (unless an applicant requests non-publication). This number is distinct from the application number. \n\nPurpose: Identifies the publicly available version of the application. \n\nFormat: Varies by jurisdiction, often similar to application numbers but includes an additional suffix indicating publication. \n\nExample:\n - US: `\"US20240000123A1\"` (indicates the first publication of application US20240000123) \n - Europe: `\"EP23123456A1\"` (first publication of European application EP23123456). \n\nWIPO ST.96 v8.0: \n - Publication Number field: .", + "examples": [ + "US20240000123A1", + "EP23123456A1" + ] }, "title": { "type": "string", @@ -187,7 +191,7 @@ }, "assertionType": { "title": "Assertion Type", - "description": "The type of assertion being made about the patent or patent family. Examples include ownership, licensing, and standards inclusion.", + "description": "The type of assertion being made about the patent or patent family.", "enum": [ "ownership", "license", diff --git a/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json b/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json index ee769ed39..ed0ff98cc 100644 --- a/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-release-notes-2.0.schema.json @@ -106,7 +106,8 @@ "locale": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/locale", "title": "Locale", - "description": "The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: `\"en\"`, `\"en-US\"`, `\"fr\"` and `\"fr-CA\"`." + "description": "The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code.", + "examples": ["en", "en-US", "fr", "fr-CA"] }, "text": { "title": "Release note content", diff --git a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json index 237c3f963..c227367a9 100644 --- a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json @@ -514,7 +514,8 @@ "timeframe": { "type": "string", "title": "Timeframe", - "description": "The period over which the probability or frequency is assessed, expressed as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) duration, for example `\"P1Y\"` for one year." + "description": "The period over which the probability or frequency is assessed, expressed as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) duration, for example `\"P1Y\"` for one year.", + "examples": ["P1Y", "P1M", "P23DT23H", "PT1M"] }, "range": { "$ref": "#/$defs/estimateRange", @@ -1593,7 +1594,8 @@ }, "horizon": { "type": "string", - "description": "The time horizon over which this appetite applies, expressed as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) duration, for example `\"P1Y\"` for one year." + "description": "The time horizon over which this appetite applies, expressed as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) duration, for example `\"P1Y\"` for one year.", + "examples": ["P1Y", "P1M", "P23DT23H", "PT1M"] }, "nextReview": { "type": "string", diff --git a/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json b/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json index ba05ac82f..afd7f67b7 100644 --- a/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json @@ -205,13 +205,15 @@ "type": "string", "minLength": 1, "title": "Scheme Version", - "description": "The version or edition of the registry that issued the identifier, for example `\"4.20\"` for CWE or `\"8.0\"` for HFACS." + "description": "The version or edition of the registry that issued the identifier, for example `\"4.20\"` for CWE or `\"8.0\"` for HFACS.", + "examples": ["4.20", "8.0"] }, "value": { "type": "string", "minLength": 1, "title": "Value", - "description": "The identifier value as issued by the registry, for example `\"CWE-502\"`." + "description": "The identifier value as issued by the registry.", + "examples": ["CWE-502"] } }, "allOf": [ From ecc40e5cd8b000d5eb84087522d6cdaec2404bf5 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 14:41:08 +0100 Subject: [PATCH 18/30] remove "optional" Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-behavior-2.0.schema.json | 2 +- .../modules/cyclonedx-certification-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-common-2.0.schema.json | 10 +++++----- schema/2.0/modules/cyclonedx-evidence-2.0.schema.json | 6 +++--- schema/2.0/modules/cyclonedx-party-2.0.schema.json | 10 +++++----- .../2.0/modules/cyclonedx-requirement-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-risk-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-threat-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-weakness-2.0.schema.json | 2 +- 9 files changed, 19 insertions(+), 19 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json b/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json index 116d37e76..24a4b7d9b 100644 --- a/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-behavior-2.0.schema.json @@ -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", diff --git a/schema/2.0/modules/cyclonedx-certification-2.0.schema.json b/schema/2.0/modules/cyclonedx-certification-2.0.schema.json index 47590b721..19e0adc4f 100644 --- a/schema/2.0/modules/cyclonedx-certification-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-certification-2.0.schema.json @@ -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", diff --git a/schema/2.0/modules/cyclonedx-common-2.0.schema.json b/schema/2.0/modules/cyclonedx-common-2.0.schema.json index dc5066b70..b026ed768 100644 --- a/schema/2.0/modules/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-common-2.0.schema.json @@ -132,7 +132,7 @@ }, "encoding": { "title": "Encoding", - "description": "Specifies the optional encoding the text is represented in.", + "description": "Specifies the encoding the text is represented in.", "enum": [ "base64" ], @@ -323,7 +323,7 @@ "properties": { "refId": { "title": "Reference Identifier", - "description": "An optional identifier which can be used to reference the address elsewhere in the document. Every `refId` shall be unique within the document.", + "description": "An identifier which can be used to reference the address elsewhere in the document. Every `refId` shall be unique within the document.", "$ref": "#/$defs/refIdType" }, "country": { @@ -371,7 +371,7 @@ "refId": { "$ref": "#/$defs/refIdType", "title": "Reference Identifier", - "description": "An optional identifier which can be used to reference the object elsewhere in the document. Every `refId` shall be unique within the document." + "description": "An identifier which can be used to reference the object elsewhere in the document. Every `refId` shall be unique within the document." }, "name": { "type": "string", @@ -419,7 +419,7 @@ "refId": { "$ref": "#/$defs/refIdType", "title": "Reference Identifier", - "description": "An optional identifier which can be used to reference the object elsewhere in the document. Every `refId` shall be unique within the document." + "description": "An identifier which can be used to reference the object elsewhere in the document. Every `refId` shall be unique within the document." }, "name": { "type": "string", @@ -902,7 +902,7 @@ "properties": { "text": { "title": "Diff text", - "description": "Specifies the optional text of the diff.", + "description": "Specifies the text of the diff.", "$ref": "#/$defs/attachment" }, "url": { diff --git a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json index 763318f64..aeb430ef0 100644 --- a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json @@ -139,12 +139,12 @@ "name": { "type": "string", "title": "Name", - "description": "An optional name or label for this path, for example the entry point through which the subject is reached." + "description": "A name or label for this path, for example the entry point through which the subject is reached." }, "description": { "type": "string", "title": "Description", - "description": "An optional description of this path." + "description": "A description of this path." }, "frames": { "type": "array", @@ -557,7 +557,7 @@ } ], "title": "Reference", - "description": "An optional reference, by `refId`, to the specific determination this material corroborates, for example a presence evidence entry. This links proof to a particular claim and perspective rather than leaving it pooled and unattributed." + "description": "A reference, by `refId`, to the specific determination this material corroborates, for example a presence evidence entry. This links proof to a particular claim and perspective rather than leaving it pooled and unattributed." }, "type": { "$ref": "#/$defs/evidenceDataType", diff --git a/schema/2.0/modules/cyclonedx-party-2.0.schema.json b/schema/2.0/modules/cyclonedx-party-2.0.schema.json index b7f9ca893..bf44cf5c4 100644 --- a/schema/2.0/modules/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-party-2.0.schema.json @@ -109,7 +109,7 @@ }, "role": { "title": "Role", - "description": "A role that a party fulfils. May be a predefined role from the CycloneDX role taxonomy or a custom role definition. The optional `order` property ranks parties that share the same role, supporting use cases such as primary versus alternate suppliers in hardware manufacturing supply chains.", + "description": "A role that a party fulfils. May be a predefined role from the CycloneDX role taxonomy or a custom role definition. The `order` property ranks parties that share the same role, supporting use cases such as primary versus alternate suppliers in hardware manufacturing supply chains.", "oneOf": [ { "$ref": "#/$defs/preDefinedRole" }, { @@ -411,7 +411,7 @@ "sortName": { "type": "string", "title": "Sort Name", - "description": "Optional sortable form of the name for catalog and index views. Use when the natural form of `name` does not sort intuitively, for example a comma-separated last-name-first form.", + "description": "Sortable form of the name for catalog and index views. Use when the natural form of `name` does not sort intuitively, for example a comma-separated last-name-first form.", "examples": [ "Lovelace, Ada", "García López, Maria del Carmen" ] }, "honorificPrefix": { @@ -532,7 +532,7 @@ }, "kind": { "title": "Kind", - "description": "The kind of system the party represents. May be a predefined kind from the CycloneDX system-kind taxonomy expressed as a plain string, or a custom kind expressed as an object with `name` and optional `description`.", + "description": "The kind of system the party represents. May be a predefined kind from the CycloneDX system-kind taxonomy expressed as a plain string, or a custom kind expressed as an object with `name` and `description`.", "oneOf": [ { "title": "Pre-Defined Kind", @@ -625,7 +625,7 @@ }, "archetype": { "title": "Archetype", - "description": "The persona archetype. May be a predefined archetype from the CycloneDX persona-archetype taxonomy expressed as a plain string, or a custom archetype expressed as an object with `name` and optional `description`.", + "description": "The persona archetype. May be a predefined archetype from the CycloneDX persona-archetype taxonomy expressed as a plain string, or a custom archetype expressed as an object with `name` and `description`.", "oneOf": [ { "title": "Pre-Defined Archetype", @@ -760,7 +760,7 @@ "properties": { "scheme": { "title": "Scheme", - "description": "The identifier scheme. May be a predefined scheme from the CycloneDX identifier-scheme taxonomy expressed as a plain string, or a custom scheme expressed as an object with `name` and optional `description` and `url`.", + "description": "The identifier scheme. May be a predefined scheme from the CycloneDX identifier-scheme taxonomy expressed as a plain string, or a custom scheme expressed as an object with `name` and `description` and `url`.", "oneOf": [ { "title": "Pre-Defined Scheme", diff --git a/schema/2.0/modules/cyclonedx-requirement-2.0.schema.json b/schema/2.0/modules/cyclonedx-requirement-2.0.schema.json index 47bb7919c..5c1478226 100644 --- a/schema/2.0/modules/cyclonedx-requirement-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-requirement-2.0.schema.json @@ -98,7 +98,7 @@ "parent": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", "title": "Parent Reference", - "description": "Optional reference using bom-link or `refId` to a parent requirement. Establishes a hierarchy of requirements." + "description": "Reference using bom-link or `refId` to a parent requirement. Establishes a hierarchy of requirements." }, "rationale": { "type": "string", diff --git a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json index c227367a9..1108f5e9a 100644 --- a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json @@ -1423,7 +1423,7 @@ }, "description": { "type": "string", - "description": "An optional explanation for custom aggregation approaches." + "description": "An explanation for custom aggregation approaches." } }, "description": "The aggregated risk result for this assessment." diff --git a/schema/2.0/modules/cyclonedx-threat-2.0.schema.json b/schema/2.0/modules/cyclonedx-threat-2.0.schema.json index 7560966da..1790a6e65 100644 --- a/schema/2.0/modules/cyclonedx-threat-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-threat-2.0.schema.json @@ -854,7 +854,7 @@ "root": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refLinkType", "title": "Root Reference", - "description": "Optional reference using bom-link or `refId` to the root node within nodes, representing the attacker goal. When omitted, the root is the node that no other node lists as a child." + "description": "Reference using bom-link or `refId` to the root node within nodes, representing the attacker goal. When omitted, the root is the node that no other node lists as a child." }, "nodes": { "type": "array", diff --git a/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json b/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json index afd7f67b7..49d68d820 100644 --- a/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-weakness-2.0.schema.json @@ -39,7 +39,7 @@ "properties": { "refId": { "$ref": "cyclonedx-common-2.0.schema.json#/$defs/refIdType", - "description": "An optional identifier which can be used to reference the weakness elsewhere using a `refId` or bom-link." + "description": "An identifier which can be used to reference the weakness elsewhere using a `refId` or bom-link." }, "kind": { "title": "Kind", From eec98ae20e36a1ebf9b2c83da9beab7e95c021ec Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 14:44:59 +0100 Subject: [PATCH 19/30] fix misplaced/duplicate docs Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-data-2.0.schema.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-data-2.0.schema.json b/schema/2.0/modules/cyclonedx-data-2.0.schema.json index 3c7a2d52e..e2ab80f49 100644 --- a/schema/2.0/modules/cyclonedx-data-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-data-2.0.schema.json @@ -719,9 +719,7 @@ "HIPAA", "PCI-DSS" ] - }, - "title": "Data flow direction", - "description": "Specifies the flow direction of the data. Direction is relative to the service." + } }, "dataContents": { "type": "object", From 517a03f8e042b29e2e71c124730aa1b4c4b35161 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 15:20:00 +0100 Subject: [PATCH 20/30] examples Signed-off-by: Jan Kowalleck --- .../2.0/modules/cyclonedx-party-2.0.schema.json | 4 ++-- .../modules/cyclonedx-physical-2.0.schema.json | 14 ++++++++++---- schema/2.0/modules/cyclonedx-risk-2.0.schema.json | 15 ++++++++++++--- 3 files changed, 24 insertions(+), 9 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-party-2.0.schema.json b/schema/2.0/modules/cyclonedx-party-2.0.schema.json index bf44cf5c4..c7aba2c37 100644 --- a/schema/2.0/modules/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-party-2.0.schema.json @@ -376,7 +376,7 @@ "name": { "type": "string", "title": "Name", - "description": "Label describing the URL, such as `\"homepage\"`, `\"support\"`, `\"press\"`, `\"status\"`, or `\"repository\"`.", + "description": "Label describing the URL.", "examples": [ "homepage", "support", "press", "status", "repository" ] }, "url": { @@ -472,7 +472,7 @@ "name": { "type": "string", "title": "Name", - "description": "Label describing the phone, such as `\"office\"`, `\"mobile\"`, `\"fax\"`, or `\"pager\"`.", + "description": "Label describing the phone.", "examples": [ "office", "mobile", "fax", "pager" ] }, "number": { diff --git a/schema/2.0/modules/cyclonedx-physical-2.0.schema.json b/schema/2.0/modules/cyclonedx-physical-2.0.schema.json index dc0a4b6f6..40006587e 100644 --- a/schema/2.0/modules/cyclonedx-physical-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-physical-2.0.schema.json @@ -15,12 +15,14 @@ "type": "string", "minLength": 1, "title": "Category", - "description": "High-level category, such as `\"semiconductor\"`, `\"passive\"`, `\"connector\"`, `\"electromechanical\"`, or `\"optoelectronic\"`." + "description": "High-level category.", + "examples": ["semiconductor", "passive", "connector", "electromechanical", "optoelectronic"] }, "subcategory": { "type": "string", "title": "Subcategory", - "description": "More specific classification within the category, such as `\"microcontroller\"`, `\"voltage-regulator\"`, or `\"ceramic-resonator\"`." + "description": "More specific classification within the category.", + "examples": ["microcontroller", "voltage-regulator", "ceramic-resonator"] }, "codes": { "type": "array", @@ -79,8 +81,12 @@ "uniqueItems": true, "minItems": 1, "title": "Designators", - "description": "Reference designators identifying the placement on the assembly, such as `\"U5\"`, `\"R12\"`, `\"C3\"`.", - "examples": [ [ "U5" ], [ "C3", "C4", "C9", "C11", "C14", "C15" ] ] + "description": "Reference designators identifying the placement on the assembly.", + "examples": [ + ["U5"], + ["R12"], + ["C3", "C4", "C9", "C11", "C14", "C15"] + ] }, "layer": { "type": "string", diff --git a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json index 1108f5e9a..8c11e104c 100644 --- a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json @@ -547,8 +547,13 @@ "name": { "type": "string", "title": "Name", - "description": "The name of the likelihood factor being evaluated. Should clearly identify the dimension of likelihood being assessed, such as `\"Threat Actor Capability\"`, `\"Exploit Availability\"`, or `\"Control Effectiveness\"`.", - "minLength": 1 + "description": "The name of the likelihood factor being evaluated. Should clearly identify the dimension of likelihood being assessed.", + "minLength": 1, + "examples": [ + "Threat Actor Capability", + "Exploit Availability", + "Control Effectiveness" + ] }, "type": { "title": "Type", @@ -817,7 +822,11 @@ "type": "string", "minLength": 1, "title": "Name", - "description": "The name of the impact factor being evaluated, such as `\"Financial damage\"` or `\"Reputation damage\"`." + "description": "The name of the impact factor being evaluated.", + "examples": [ + "Financial damage", + "Reputation damage" + ] }, "category": { "$ref": "#/$defs/impactCategory", From 339498d265b8d832c5a98781ea42a73f99da5e6f Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 16:04:21 +0100 Subject: [PATCH 21/30] examples Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-common-2.0.schema.json | 1 - 1 file changed, 1 deletion(-) diff --git a/schema/2.0/modules/cyclonedx-common-2.0.schema.json b/schema/2.0/modules/cyclonedx-common-2.0.schema.json index b026ed768..8786ae3c4 100644 --- a/schema/2.0/modules/cyclonedx-common-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-common-2.0.schema.json @@ -612,7 +612,6 @@ "^ext:[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}:.+$": { "description": "CycloneDX supports a structured and namespace-aware mechanism for extensibility through the use of extensible properties. This mechanism enables organizations, ecosystems, and tool vendors to safely introduce custom properties without conflicting with the core schema or other extensions.\n\nExtensible properties are defined as a JSON object whose keys shall conform to a strict pattern that resembles a reverse domain name structure, prefixed with `\"ext:\"`. This pattern provides a namespacing convention that aligns with well-established practices in other structured formats (e.g., XML namespaces).\n\nValues that are objects shall declare the schema they conform to via `$schema`. This requirement applies recursively to objects contained in arrays, at any nesting depth.", "examples": [ - "ext::", "ext:example.org:myExtension" ], "$ref": "#/$defs/extensibleProperties/$defs/propertyValue" From fcde0043d9e435472cf9eeedb9f7223a13759611 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 16:18:34 +0100 Subject: [PATCH 22/30] examples Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json | 6 ++++-- .../2.0/modules/cyclonedx-cryptography-2.0.schema.json | 3 ++- schema/2.0/modules/cyclonedx-requirement-2.0.schema.json | 3 ++- schema/2.0/modules/cyclonedx-usecase-2.0.schema.json | 9 ++++++--- 4 files changed, 14 insertions(+), 7 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json b/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json index 1c0abaa94..330849056 100644 --- a/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json @@ -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", "P2Y5M3W1D"] } } }, @@ -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", diff --git a/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json b/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json index 344cb8975..ec277d8ce 100644 --- a/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-cryptography-2.0.schema.json @@ -640,7 +640,8 @@ "format": { "type": "string", "title": "Format", - "description": "The format of the related cryptographic material (e.g. `\"P8\"`, `\"PEM\"`, `\"DER\"`)." + "description": "The format of the related cryptographic material.", + "examples": ["P8", "PEM", "DER"] }, "securedBy": { "$ref": "#/$defs/securedBy", diff --git a/schema/2.0/modules/cyclonedx-requirement-2.0.schema.json b/schema/2.0/modules/cyclonedx-requirement-2.0.schema.json index 5c1478226..ce3b974ac 100644 --- a/schema/2.0/modules/cyclonedx-requirement-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-requirement-2.0.schema.json @@ -29,7 +29,8 @@ "id": { "type": "string", "title": "Identifier", - "description": "A unique identifier for the requirement, often used in requirement management systems (e.g., `\"REQ-001\"`)." + "description": "A unique identifier for the requirement, often used in requirement management systems.", + "examples": ["REQ-001"] }, "name": { "type": "string", diff --git a/schema/2.0/modules/cyclonedx-usecase-2.0.schema.json b/schema/2.0/modules/cyclonedx-usecase-2.0.schema.json index b20f2d7a5..a6802ccc4 100644 --- a/schema/2.0/modules/cyclonedx-usecase-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-usecase-2.0.schema.json @@ -31,7 +31,8 @@ "type": "string", "title": "Name", "minLength": 1, - "description": "The name or title of the use case, typically expressed as a verb phrase that captures the goal from the actor's perspective (e.g., `\"Place Order\"`, `\"Reset Password\"`)." + "description": "The name or title of the use case, typically expressed as a verb phrase that captures the goal from the actor's perspective.", + "examples": ["Place Order", "Reset Password"] }, "description": { "type": "string", @@ -175,7 +176,8 @@ "type": "string", "title": "Name", "minLength": 1, - "description": "A short, descriptive name identifying this alternative flow (e.g., `\"Payment Declined\"`, `\"Guest Checkout\"`)." + "description": "A short, descriptive name identifying this alternative flow.", + "examples": ["Payment Declined", "Guest Checkout"] }, "description": { "type": "string", @@ -212,7 +214,8 @@ "type": "string", "title": "Name", "minLength": 1, - "description": "A short, descriptive name identifying this exception scenario (e.g., `\"Session Timeout\"`, `\"Insufficient Funds\"`, `\"Service Unavailable\"`)." + "description": "A short, descriptive name identifying this exception scenario.", + "examples": ["Session Timeout", "Insufficient Funds", "Service Unavailable"] }, "description": { "type": "string", From 42d99eeb87a3bfc8b99762e413763473e48b00fe Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 17:09:14 +0100 Subject: [PATCH 23/30] examples Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-party-2.0.schema.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-party-2.0.schema.json b/schema/2.0/modules/cyclonedx-party-2.0.schema.json index c7aba2c37..d1d105086 100644 --- a/schema/2.0/modules/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-party-2.0.schema.json @@ -495,8 +495,8 @@ "name": { "type": "string", "title": "Name", - "description": "Label describing the URL, such as `\"homepage\"`, `\"github\"`, `\"linkedin\"`, `\"mastodon\"`, or `\"orcid\"`.", - "examples": [ "homepage", "github", "linkedin", "orcid" ] + "description": "Label describing the URL.", + "examples": [ "homepage", "github", "linkedin", "mastodon", ,"orcid" ] }, "url": { "type": "string", From e9f8be2d83ae62bd6e0f4377013b3a0576bf5aa9 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 17:18:50 +0100 Subject: [PATCH 24/30] fix Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-party-2.0.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/modules/cyclonedx-party-2.0.schema.json b/schema/2.0/modules/cyclonedx-party-2.0.schema.json index d1d105086..fac719ae5 100644 --- a/schema/2.0/modules/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-party-2.0.schema.json @@ -496,7 +496,7 @@ "type": "string", "title": "Name", "description": "Label describing the URL.", - "examples": [ "homepage", "github", "linkedin", "mastodon", ,"orcid" ] + "examples": [ "homepage", "github", "linkedin", "mastodon", "orcid" ] }, "url": { "type": "string", From cf5db049bb31cd0d3191a4a84f85146a48972724 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 17:34:34 +0100 Subject: [PATCH 25/30] examples Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json | 2 +- schema/2.0/modules/cyclonedx-evidence-2.0.schema.json | 1 - schema/2.0/modules/cyclonedx-party-2.0.schema.json | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json b/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json index 330849056..e014b9fdf 100644 --- a/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-blueprint-2.0.schema.json @@ -342,7 +342,7 @@ "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).", - "examples": ["P1Y", "P3M", "P5W", "P23D", "P2Y5M3W1D"] + "examples": ["P1Y", "P3M", "P5W", "P23D"] } } }, diff --git a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json index aeb430ef0..af10f43eb 100644 --- a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json @@ -26,7 +26,6 @@ "examples": [ "src/authentication/login.py", "https://example.com/login", - "npm:lodash@4.17.21", "docker.io/library/nginx:1.25" ] }, diff --git a/schema/2.0/modules/cyclonedx-party-2.0.schema.json b/schema/2.0/modules/cyclonedx-party-2.0.schema.json index fac719ae5..f35df3f5a 100644 --- a/schema/2.0/modules/cyclonedx-party-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-party-2.0.schema.json @@ -449,7 +449,7 @@ "name": { "type": "string", "title": "Name", - "description": "Label describing the email, such as `\"work\"`, `\"personal\"`, `\"support\"`, or `\"security\"`.", + "description": "Label describing the email.", "examples": [ "work", "personal", "support", "security" ] }, "address": { From 7821ed72f544fec85325e077d81ba8a05fa4e9d4 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 17:48:52 +0100 Subject: [PATCH 26/30] docs Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-risk-2.0.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json index 8c11e104c..251d5ec99 100644 --- a/schema/2.0/modules/cyclonedx-risk-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-risk-2.0.schema.json @@ -400,7 +400,7 @@ "rating": { "type": "object", "title": "Rating", - "description": "A methodology-neutral assessment of risk along likelihood and impact, with an overall score. The same shape expresses inherent, residual, and target risk so reductions can be compared. A rating can be qualitative (a `score.level`), semi-quantitative (a numeric `score` on a bounded scale), or quantitative (for example a probable monetary loss under [FAIR](https://www.fairinstitute.org/)). For a catalogue of assessment techniques, see [IEC 31010](https://www.iso.org/standard/72140.html).", + "description": "A methodology-neutral assessment of risk along likelihood and impact, with an overall score. The same shape expresses inherent, residual, and target risk so reductions can be compared. A rating can be qualitative (a `score.level`), semi-quantitative (a numeric `score.score` on a bounded scale), or quantitative (for example a probable monetary loss under [FAIR](https://www.fairinstitute.org/)). For a catalogue of assessment techniques, see [IEC 31010](https://www.iso.org/standard/72140.html).", "additionalProperties": false, "properties": { "likelihood": { From c08788ef68a78ca9e5dc6e8ce7a93f20a2c510fb Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 17:53:00 +0100 Subject: [PATCH 27/30] docs Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-component-2.0.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/modules/cyclonedx-component-2.0.schema.json b/schema/2.0/modules/cyclonedx-component-2.0.schema.json index 0b29f2ec5..3508864f4 100644 --- a/schema/2.0/modules/cyclonedx-component-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-component-2.0.schema.json @@ -280,7 +280,7 @@ "materialForm": { "$ref": "cyclonedx-physical-2.0.schema.json#/$defs/materialForm", "title": "Material Form", - "description": "Physical form in which the material is supplied, expressed as a predefined material form or a custom material form. This object may only be specified for components with `type=\"material\"` and shall not be specified for other component types." + "description": "Physical form in which the material is supplied, expressed as a predefined material form or a custom material form. This object may only be specified for components with `type=\"material\"`, and shall not be specified for other component types." }, "quantity": { "$ref": "cyclonedx-physical-2.0.schema.json#/$defs/quantity", From acdab8a111b5396fecdf2adcfd80c49e0f34076e Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 18:05:30 +0100 Subject: [PATCH 28/30] rolback Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-formulation-2.0.schema.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json b/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json index e3594f066..d36969f7f 100644 --- a/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-formulation-2.0.schema.json @@ -675,7 +675,7 @@ "properties": { "source": { "title": "Source", - "description": "A reference to the component or service that provided the input to the task (e.g., reference to a service that is the `source` of a blueprint flow).", + "description": "A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of `inbound`).", "examples": [ "source code repository", "database" @@ -761,7 +761,7 @@ }, "target": { "title": "Target", - "description": "Component or service that received the output from the task (e.g., reference to an artifactory service that is the `destination` of a blueprint flow).", + "description": "Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of `outbound`).", "examples": ["a log file described as an `externalReference` within its target domain."], "$ref": "#/$defs/resourceReferenceChoice" }, From 4de4a6e7189993642ab9d905ae6cf7cb84af6572 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Wed, 11 Nov 2026 18:09:06 +0100 Subject: [PATCH 29/30] docs Signed-off-by: Jan Kowalleck --- .../2.0/modules/cyclonedx-evidence-2.0.schema.json | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json index af10f43eb..647b36d78 100644 --- a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json @@ -422,18 +422,6 @@ "$ref": "cyclonedx-party-2.0.schema.json#/$defs/role", "title": "Role", "description": "The role or vantage in which the party was involved.", - "examples": [ - "supplier", - "manufacturer", - "distributor", - "operator", - "customer", - "end-user", - "asserter", - "auditor", - "reviewer", - "researcher" - ] } } }, From 6a6af54c1f82df85958c0fc80289b68548aa7716 Mon Sep 17 00:00:00 2001 From: Jan Kowalleck Date: Thu, 12 Nov 2026 10:20:54 +0100 Subject: [PATCH 30/30] fix Signed-off-by: Jan Kowalleck --- schema/2.0/modules/cyclonedx-evidence-2.0.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json index 647b36d78..dbc81de35 100644 --- a/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json +++ b/schema/2.0/modules/cyclonedx-evidence-2.0.schema.json @@ -421,7 +421,7 @@ "role": { "$ref": "cyclonedx-party-2.0.schema.json#/$defs/role", "title": "Role", - "description": "The role or vantage in which the party was involved.", + "description": "The role or vantage in which the party was involved." } } },