CycloneDX/sbom-utility

Explore using custom struct tags for CycloneDX property versioning

Open

#24 opened on May 18, 2023

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

Repository metrics

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

Description

If we want to have special processing for JSON encoding/decoding (e.g., marshal/unmarshal) it would be helpful to enable this via custom struct tags.

For example:

// v1.3 added "compositions"
Compositions []CDXCompositions `json:"compositions,omitempty" cdx:"v1.3"`
// v1.4 added "vulnerabilities", "signature"
Vulnerabilities []CDXVulnerability `json:"vulnerabilities,omitempty" cdx:"v1.4"`

Contributor guide

Research direction
Investigate how to implement custom struct tags for JSON encoding/decoding in Go, referencing the existing CycloneDX structures and marshal/unmarshal code.
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
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60