Skip to content

docs: missing schema support table & update schema support to reflect version 7.0.0 #584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
madpah merged 2 commits into from
Apr 10, 2024
Merged

docs: missing schema support table & update schema support to reflect version 7.0.0 #584

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8455e47
doc: fixed Schema Support Table in docs which prevented display on RTD
madpah Apr 10, 2024
df4478b
doc: updated schema-support to reflect current implementation
madpah Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 34 additions & 6 deletions docs/schema-support.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,19 @@ The following sub-sections aim to explain what support this library provides and
by calling out support for data as defined in the latest CycloneDX standard specification, regardless of whether it is
supported in prior versions of the CycloneDX schema.

Root Level Schema Support
-------------------------

+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| Data Path | Supported? | Notes |
+============================+===============+===================================================================================================+
| ``bom[@version]`` | Yes | |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom[@serialNumber]`` | Yes | |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.metadata`` | Yes | |
| ``bom.metadata`` | Yes | Not supported: ``lifecycles`` |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.components`` | Yes | Not supported: ``modified`` (as it is deprecated), ``signature``. |
| ``bom.components`` | Yes | Not supported: ``modified`` (as it is deprecated), ``modelCard``, ``data``, ``signature``. |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.services`` | Yes | Not supported: ``signature``. |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
Expand All @@ -40,13 +43,38 @@ supported in prior versions of the CycloneDX schema.
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.compositions`` | No | |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.properties`` | No | See `schema specification bug 130`_ |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.vulnerabilities`` | Yes | Note: Prior to CycloneDX 1.4, these were present under ``bom.components`` via a schema extension. |
| | | Note: As of ``cyclonedx-python-lib`` ``>3.0.0``, Vulnerability are modelled differently |
| | | Note: As of ``cyclonedx-python-lib`` ``>3.0.0``, Vulnerability are modelled differently |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.annotations`` | No | |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.formulation`` | No | |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.declarations`` | No | |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.definitions`` | No | |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.properties`` | No | See `schema specification bug 130`_ |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+
| ``bom.signature`` | No | |
+----------------------------+---------------+---------------------------------------------------------------------------------------------------+

Internal Model Schema Support
-----------------------------

+----------------------------+---------------+----------------------------------------------------------------------------------------------+
| Internal Model | Supported? | Notes |
+============================+===============+==============================================================================================+
| ``ComponentEvidence`` |Yes | Not currently supported: ``callstack``, ``identity``, ``occurrences``. |
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
| ``DisjunctiveLicense`` |Yes | Not currently supported: ``@bom-ref``, ``licensing``, ``properties``. |
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
| ``LicenseExpression`` |Yes | Not currently supported: ``@bom-ref`` |
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
| ``OrganizationalContact`` |Yes | Not currently supported: ``@bom-ref`` |
+----------------------------+---------------+----------------------------------------------------------------------------------------------+
| ``OrganizationalEntity`` |Yes | Not currently supported: ``@bom-ref`` |
+----------------------------+---------------+----------------------------------------------------------------------------------------------+

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

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