cyclonedx-python-lib icon indicating copy to clipboard operation
cyclonedx-python-lib copied to clipboard

[DOCS]: Add an Example of Validating SBOMs

Open saquibsaifee opened this issue 1 year ago • 2 comments

Create documentation to guide users on validating SBOMs.

The CycloneDX Python library can validate an SBOM based on the schema, independent of the library's support for SBOM serialization, which is a valuable feature. However, the current documentation lacks clear examples and instructions on effectively utilizing this validation functionality.

The following points should be addressed in the documentation:

An overview of how to validate SBOMs based on schema specifications. Examples demonstrating the validation process, including code snippets using JsonStrictValidator and other relevant classes.

saquibsaifee avatar Oct 13 '24 16:10 saquibsaifee

examples: https://github.com/CycloneDX/cyclonedx-python-lib/blob/a210809efb34c2dc895fc0c6d96a3412a9097625/examples/complex_deserialize.py#L148-L156

jkowalleck avatar Oct 13 '24 20:10 jkowalleck

I will be working on this.

saquibsaifee avatar Oct 14 '24 15:10 saquibsaifee