Skip to content

docs: Add comprehensive SBOM validation guide#933

Open
saquibsaifee wants to merge 6 commits intoCycloneDX:mainfrom
saquibsaifee:docs/add-validation-guide
Open

docs: Add comprehensive SBOM validation guide#933
saquibsaifee wants to merge 6 commits intoCycloneDX:mainfrom
saquibsaifee:docs/add-validation-guide

Conversation

@saquibsaifee
Copy link
Contributor

@saquibsaifee saquibsaifee commented Jan 29, 2026 •
edited
Loading

Description

Adds validation documentation with practical examples for validating CycloneDX SBOMs, addressing #708.

  • Add new validation.rst documentation covering validation workflows
  • Include practical examples for JSON and XML validation
  • Document error handling patterns with ValidationError inspection
  • Add multi-version support examples (CycloneDX 1.2-1.6)
  • Provide production integration examples (FastAPI)
  • Include best practices for validation in production systems
  • Add validation.rst to documentation index

Resolves or fixes issue: #708

Affirmation

@saquibsaifee saquibsaifee requested a review from a team as a code owner January 29, 2026 23:20
@read-the-docs-community
Copy link

read-the-docs-community bot commented Jan 29, 2026 •
edited
Loading

Documentation build overview

📚 CycloneDX Python Library | 🛠️ Build #31324535 | 📁 Comparing 0295ccc against latest (f311b61)


🔍 Preview build

Show files changed (2 files in total): 📝 2 modified | ➕ 0 added | ➖ 0 deleted
File Status
examples.html 📝 modified
index.html 📝 modified

@saquibsaifee saquibsaifee force-pushed the docs/add-validation-guide branch from f2447ef to 11db9d3 Compare January 29, 2026 23:20
@saquibsaifee
Copy link
Contributor Author

saquibsaifee commented Jan 30, 2026

@jkowalleck thoughts?

@jkowalleck
Copy link
Member

jkowalleck commented Feb 6, 2026

docs preview: https://cyclonedx-python-library--933.org.readthedocs.build/en/933/

@jkowalleck
Copy link
Member

jkowalleck commented Feb 6, 2026

the guide is too verbose for me, and mostly lives of example code.
instead of writing texts, better add more examples.

example code shall go here: https://github.com/CycloneDX/cyclonedx-python-lib/tree/main/examples

these examples might be used in the docs as shown here: https://github.com/CycloneDX/cyclonedx-python-lib/blob/main/docs/examples.rst

jkowalleck
jkowalleck reviewed Feb 6, 2026
View reviewed changes
@saquibsaifee
Copy link
Contributor Author

saquibsaifee commented Feb 8, 2026

Following reviewer feedback, the documentation has been streamlined to focus on concepts, while the practical code examples have been moved to a new standalone file.

@saquibsaifee
Copy link
Contributor Author

saquibsaifee commented Feb 8, 2026

I don't know if the XML validation pattern works, as I have personally not used the XML validation, so keep me honest there.

saquibsaifee and others added 6 commits February 8, 2026 17:50
@saquibsaifee
docs: Add comprehensive SBOM validation guide
b55d436 
- Add new validation.rst documentation covering validation workflows
- Include practical examples for JSON and XML validation
- Document error handling patterns with ValidationError inspection
- Add multi-version support examples (CycloneDX 1.2-1.6)
- Provide production integration examples (FastAPI)
- Include best practices for validation in production systems
- Add validation.rst to documentation index

Addresses CycloneDX#708

Signed-off-by: Saquib Saifee <saquibsaifee@ibm.com>
Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
@saquibsaifee @jkowalleck
Update docs/validation.rst
c9081d4 
Co-authored-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
@saquibsaifee @jkowalleck
Update docs/validation.rst
e52401f 
Co-authored-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
@saquibsaifee @jkowalleck
Update docs/validation.rst
1061440 
Co-authored-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
@saquibsaifee
docs: use literalinclude for validation examples and improve format d…
87749c2 
…etection

Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
@saquibsaifee
docs: remove reference to validation.rst in index.rst
0295ccc 
Signed-off-by: Saquib Saifee <saquibsaifee2@gmail.com>
@saquibsaifee saquibsaifee force-pushed the docs/add-validation-guide branch from 062b013 to 0295ccc Compare February 8, 2026 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jkowalleck jkowalleck jkowalleck left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@saquibsaifee @jkowalleck