Skip to content

Commit d230e67

Browse files
authored
docs: missing schema support table & update schema support to reflect version 7.0.0 (#584)
Signed-off-by: Paul Horton <[email protected]>
1 parent a28013b commit d230e67

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

docs/schema-support.rst

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,19 @@ The following sub-sections aim to explain what support this library provides and
2121
by calling out support for data as defined in the latest CycloneDX standard specification, regardless of whether it is
2222
supported in prior versions of the CycloneDX schema.
2323

24+
Root Level Schema Support
25+
-------------------------
26+
2427
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
2528
| Data Path | Supported? | Notes |
2629
+============================+===============+===================================================================================================+
2730
| ``bom[@version]`` | Yes | |
2831
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
2932
| ``bom[@serialNumber]`` | Yes | |
3033
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
31-
| ``bom.metadata`` | Yes | |
34+
| ``bom.metadata`` | Yes | Not supported: ``lifecycles`` |
3235
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
33-
| ``bom.components`` | Yes | Not supported: ``modified`` (as it is deprecated), ``signature``. |
36+
| ``bom.components`` | Yes | Not supported: ``modified`` (as it is deprecated), ``modelCard``, ``data``, ``signature``. |
3437
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
3538
| ``bom.services`` | Yes | Not supported: ``signature``. |
3639
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
@@ -40,13 +43,38 @@ supported in prior versions of the CycloneDX schema.
4043
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
4144
| ``bom.compositions`` | No | |
4245
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
43-
| ``bom.properties`` | No | See `schema specification bug 130`_ |
44-
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
4546
| ``bom.vulnerabilities`` | Yes | Note: Prior to CycloneDX 1.4, these were present under ``bom.components`` via a schema extension. |
46-
| | | Note: As of ``cyclonedx-python-lib`` ``>3.0.0``, Vulnerability are modelled differently |
47+
| | | Note: As of ``cyclonedx-python-lib`` ``>3.0.0``, Vulnerability are modelled differently |
48+
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
49+
| ``bom.annotations`` | No | |
50+
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
51+
| ``bom.formulation`` | No | |
52+
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
53+
| ``bom.declarations`` | No | |
54+
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
55+
| ``bom.definitions`` | No | |
56+
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
57+
| ``bom.properties`` | No | See `schema specification bug 130`_ |
4758
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
4859
| ``bom.signature`` | No | |
4960
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
5061

62+
Internal Model Schema Support
63+
-----------------------------
64+
65+
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
66+
| Internal Model | Supported? | Notes |
67+
+============================+===============+==============================================================================================+
68+
| ``ComponentEvidence`` |Yes | Not currently supported: ``callstack``, ``identity``, ``occurrences``. |
69+
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
70+
| ``DisjunctiveLicense`` |Yes | Not currently supported: ``@bom-ref``, ``licensing``, ``properties``. |
71+
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
72+
| ``LicenseExpression`` |Yes | Not currently supported: ``@bom-ref`` |
73+
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
74+
| ``OrganizationalContact`` |Yes | Not currently supported: ``@bom-ref`` |
75+
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
76+
| ``OrganizationalEntity`` |Yes | Not currently supported: ``@bom-ref`` |
77+
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
78+
79+
.. _schema specification bug 130: https://github.com/CycloneDX/specification/issues/130
5180

52-
.. _schema specification bug 130: https://github.com/CycloneDX/specification/issues/130

0 commit comments

Comments
 (0)