CycloneDX / CycloneDX/cyclonedx-dotnet-library

JSON Serialization: Add ability to include $schema property

Open
#443 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
28
Forks
35
PR merge metrics
No merged PRs in 30d

Description

For the CycloneDX JSON boms i generate with the library, i would find it convenient to add the JSON schema URL (top-level $schema property) to them upon serialization.
It aids in manual inspection of the bom during development.

I did not find a way to add it (apart from manually post-processing the serialized file), but maybe i was just too stupid to find it.

Contributor guide

Open the contributing guide

Research direction

The issue does not name a file or test. Start by locating the JSON serialization entry point and existing CycloneDX JSON output tests, then determine how the top-level $schema value can be included during serialization. Done means serialized CycloneDX JSON can contain the schema URL without requiring manual post-processing.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.