CycloneDX/sbom-utility

Add custom JSON Marshallers functions for CycloneDX vulnerability data structures

Open

#25 opened on May 18, 2023

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (20 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (155 stars)
PR merge metrics
 (PR metrics pending)

Description

When outputting data in JSON format, we need to remove all empty nested structs. We have done this for the license command. This reduces JSON output for downstream processing.

See this issue for more background: https://github.com/CycloneDX/sbom-utility/issues/18

See what was done for the license command here as part of the fix for issue 18: https://github.com/CycloneDX/sbom-utility/blob/custom-cmds/schema/cyclonedx_marshal.go

Contributor guide

Research direction
Examine the existing custom marshaller implementation for the license command in `schema/cyclonedx marshal.go` and replicate the pattern for vulnerability data structures. Ensure all empty nested structs are omitted in JSON output.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75