CycloneDX / CycloneDX/cyclonedx-python-lib

[DOCS]: Add an Example of Validating SBOMs

Open
#708 2 comments 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
Python
Stars
116
Forks
67
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.