@@ -96,6 +96,71 @@ outputter = get_instance(bom=bom, schema_version=SchemaVersion.V1_)
96
96
outputter.output_to_file(filename='/tmp/sbom-v1.2.xml')
97
97
```
98
98
99
+ ## Schema Support
100
+
101
+ This library is a work in progress and complete support for all parts of the CycloneDX schema will come in future releases.
102
+
103
+ Here is a summary of the parts of the schema supported by this library:
104
+
105
+ _ Note: We refer throughout using XPath, but the same is true for both XML and JSON output formats._
106
+
107
+ <table width =" 100% " >
108
+ <thead >
109
+ <tr>
110
+ <th>XPath</th>
111
+ <th>Support v1.3</th>
112
+ <th>Support v1.2</th>
113
+ <th>Support v1.1</th>
114
+ <th>Support v1.0</th>
115
+ <th>Notes</th>
116
+ </tr>
117
+ </thead >
118
+ <tbody >
119
+ <tr>
120
+ <td><code>/bom</code></td>
121
+ <td>Y</td><td>Y</td><td>Y</td><td>Y</td>
122
+ <td>
123
+ This is the root element and is supported with all it's defined attributes.
124
+ </td>
125
+ </tr>
126
+ <tr>
127
+ <td><code>/bom/metadata</code></td>
128
+ <td>Y</td><td>Y</td><td>N/A</td><td>N/A</td>
129
+ <td>
130
+ Only <code>timestamp</code> is currently supported
131
+ </td>
132
+ </tr>
133
+ <tr>
134
+ <td><code>/bom/components</code></td>
135
+ <td>Y</td><td>Y</td><td>Y</td><td>Y</td>
136
+ <td> </td>
137
+ </tr>
138
+ <tr>
139
+ <th colspan="6"><strong><code>/bom/components/component</code></strong></th>
140
+ </tr>
141
+ <tr>
142
+ <td><code>./name</code></td>
143
+ <td>Y</td><td>Y</td><td>Y</td><td>Y</td>
144
+ <td> </td>
145
+ </tr>
146
+ <tr>
147
+ <td><code>./version</code></td>
148
+ <td>Y</td><td>Y</td><td>Y</td><td>Y</td>
149
+ <td> </td>
150
+ </tr>
151
+ <tr>
152
+ <td><code>./purl</code></td>
153
+ <td>Y</td><td>Y</td><td>Y</td><td>Y</td>
154
+ <td> </td>
155
+ </tr>
156
+ </tbody >
157
+ </table >
158
+
159
+ ### Notes on Schema Support
160
+
161
+ 1 . N/A is where the CycloneDX standard does not include this
162
+ 2 . If the table above does not refer to an element, it is not currently supported
163
+
99
164
## The Fine Print
100
165
101
166
Remember:
0 commit comments