|
52 | 52 | "mappings": { |
53 | 53 | "type": "array", |
54 | 54 | "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.", |
56 | 56 | "minItems": 1, |
57 | 57 | "items": { |
58 | 58 | "$ref": "#/$defs/perspectiveMapping" |
|
69 | 69 | "perspectiveMapping": { |
70 | 70 | "type": "object", |
71 | 71 | "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.", |
73 | 73 | "additionalProperties": false, |
74 | 74 | "required": [ |
75 | 75 | "expression" |
|
78 | 78 | "expression": { |
79 | 79 | "type": "string", |
80 | 80 | "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.", |
82 | 82 | "examples": [ |
83 | 83 | "$.components[*].pedigree", |
84 | 84 | "$.components[?(@.type=='machine-learning-model')].modelCard", |
|
103 | 103 | "description": "A domain-specific description of the data type, explaining its significance within the context of the perspective." |
104 | 104 | }, |
105 | 105 | "relevance": { |
106 | | - "$ref": "#/$defs/perspectiveRelevance", |
107 | | - "title": "Relevance", |
108 | | - "description": "Indicates the importance of this data type to the perspective." |
| 106 | + "$ref": "#/$defs/perspectiveRelevance" |
109 | 107 | }, |
110 | 108 | "weight": { |
111 | 109 | "type": "number", |
|
121 | 119 | } |
122 | 120 | } |
123 | 121 | }, |
| 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 | + }, |
124 | 139 | "perspectiveDomainChoice": { |
125 | 140 | "title": "Perspective Domain Choice", |
126 | 141 | "description": "Allows selection of a pre-defined domain or specification of a custom domain.", |
|
322 | 337 | "sustainability": "Concerns related to environmental sustainability, energy efficiency, and responsible resource consumption.", |
323 | 338 | "transparency": "Concerns related to openness, auditability, and the ability for stakeholders to understand system behaviour and composition." |
324 | 339 | } |
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 | | - } |
342 | 340 | } |
343 | 341 | } |
344 | 342 | } |
0 commit comments