Skip to content

Commit c257f85

Browse files
Minor doc update
Signed-off-by: Steve Springett <[email protected]>
1 parent 9f54e54 commit c257f85

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

schema/2.0/model/cyclonedx-perspective-2.0.schema.json

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"mappings": {
5353
"type": "array",
5454
"title": "Data Type Mappings",
55-
"description": "An array of mappings that identify the types of data relevant to this perspective using path expressions. Each mapping may include domain-specific terminology.",
55+
"description": "An array of mappings that identify the types of data relevant to this perspective using JSON path expressions. Each mapping may include domain-specific terminology.",
5656
"minItems": 1,
5757
"items": {
5858
"$ref": "#/$defs/perspectiveMapping"
@@ -69,7 +69,7 @@
6969
"perspectiveMapping": {
7070
"type": "object",
7171
"title": "Perspective Mapping",
72-
"description": "Maps a path expression to domain-specific terminology, enabling audiences to interpret CycloneDX data using familiar nomenclature. Each mapping identifies a data type within the document structure and may provide alternative names and descriptions used by the target audience.",
72+
"description": "Maps a JSON path expression to domain-specific terminology, enabling audiences to interpret CycloneDX data using familiar nomenclature. Each mapping identifies a data type within the document structure and may provide alternative names and descriptions used by the target audience.",
7373
"additionalProperties": false,
7474
"required": [
7575
"expression"
@@ -78,7 +78,7 @@
7878
"expression": {
7979
"type": "string",
8080
"title": "Path Expression",
81-
"description": "A path expression that identifies the types of data relevant to this perspective. The expression syntax shall conform to the format of the document's serialisation.\nUse [JSONPath](https://datatracker.ietf.org/doc/html/rfc9535) for JSON, [XPath](https://www.w3.org/TR/xpath/) for XML, and default to JSONPath for Protocol Buffers unless otherwise specified.\nExpressions select data types within the document structure, not specific field values.",
81+
"description": "A [JSONPath](https://datatracker.ietf.org/doc/html/rfc9535) expression that identifies the types of data relevant to this perspective.",
8282
"examples": [
8383
"$.components[*].pedigree",
8484
"$.components[?(@.type=='machine-learning-model')].modelCard",
@@ -103,9 +103,7 @@
103103
"description": "A domain-specific description of the data type, explaining its significance within the context of the perspective."
104104
},
105105
"relevance": {
106-
"$ref": "#/$defs/perspectiveRelevance",
107-
"title": "Relevance",
108-
"description": "Indicates the importance of this data type to the perspective."
106+
"$ref": "#/$defs/perspectiveRelevance"
109107
},
110108
"weight": {
111109
"type": "number",
@@ -121,6 +119,23 @@
121119
}
122120
}
123121
},
122+
"perspectiveRelevance": {
123+
"type": "string",
124+
"title": "Perspective Relevance",
125+
"description": "Indicates the importance of a data type to a perspective.",
126+
"enum": [
127+
"required",
128+
"recommended",
129+
"optional",
130+
"informative"
131+
],
132+
"meta:enum": {
133+
"required": "This data type is essential for the perspective and should always be present.",
134+
"recommended": "This data type is highly relevant and should be included when available.",
135+
"optional": "This data type provides supplementary information that may be useful.",
136+
"informative": "This data type provides background context but is not directly actionable."
137+
}
138+
},
124139
"perspectiveDomainChoice": {
125140
"title": "Perspective Domain Choice",
126141
"description": "Allows selection of a pre-defined domain or specification of a custom domain.",
@@ -322,23 +337,6 @@
322337
"sustainability": "Concerns related to environmental sustainability, energy efficiency, and responsible resource consumption.",
323338
"transparency": "Concerns related to openness, auditability, and the ability for stakeholders to understand system behaviour and composition."
324339
}
325-
},
326-
"perspectiveRelevance": {
327-
"type": "string",
328-
"title": "Perspective Relevance",
329-
"description": "Indicates the importance of a data type to a perspective.",
330-
"enum": [
331-
"required",
332-
"recommended",
333-
"optional",
334-
"informative"
335-
],
336-
"meta:enum": {
337-
"required": "This data type is essential for the perspective and should always be present.",
338-
"recommended": "This data type is highly relevant and should be included when available.",
339-
"optional": "This data type provides supplementary information that may be useful.",
340-
"informative": "This data type provides background context but is not directly actionable."
341-
}
342340
}
343341
}
344342
}

0 commit comments

Comments
 (0)