CycloneDX / cyclonedx-python-lib

Python implementation of OWASP CycloneDX
https://cyclonedx.org/
Apache License 2.0
69 stars 40 forks source link

[DOCS]: Add an Example of Validating SBOMs #708

Open saquibsaifee opened 1 month ago

saquibsaifee commented 1 month ago

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.

jkowalleck commented 1 month ago

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

saquibsaifee commented 1 month ago

I will be working on this.