CycloneDX / CycloneDX/transparency-exchange-api

Add examples to all schema objects

Open
#222 1 comment 0 reactions 0 assignees View on GitHub
Prio 1
Dominant language
Shell
Stars
113
Forks
22
Avg merge
8d 12h
Merged PRs (30d)
5

Description

Some schema objects in the OpenAPI specification currently lack example definitions (e.g., TEA Artifact). Providing a concrete example for every schema object, even simple ones, would improve documentation quality and make the API easier to understand and adopt.

Each schema object should include at least one representative example illustrating valid usage.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.