Skip to content

Conversation

@saquibsaifee
Copy link
Contributor

@saquibsaifee saquibsaifee commented Jan 29, 2026

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
- 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 <[email protected]>
@read-the-docs-community
Copy link

read-the-docs-community bot commented Jan 29, 2026

Documentation build overview

📚 CycloneDX Python Library | 🛠️ Build #31203027 | 📁 Comparing 11db9d3 against latest (f311b61)


🔍 Preview build

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

@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

@jkowalleck thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant