Skip to content

OSV v3 doc updates#146

Open
crosleyzack wants to merge 2 commits into
mainfrom
osv-v3-doc-updates
Open

OSV v3 doc updates#146
crosleyzack wants to merge 2 commits into
mainfrom
osv-v3-doc-updates

Conversation

@crosleyzack

Copy link
Copy Markdown
Member

What

Add v3 OSV docs and update v2 docs

Why

Explain differences to partners and customers

Still in progress - osv v3 docs

Signed-off-by: tazinprogga <tazin.progga@chainguard.dev>
Comment thread docs/osv_v2_feed.md
| Alias field | `related` | `upstream` |
| Component detail | Not present | Per-advisory data in `ecosystem_specific.components` |
| Fixed version | Highest version across all advisories for a package | From the advisory's fixed event (no rollup) |
| Fixed version | Highest version across all advisories for a package | Aggregate fixed version across advisory events for (package, architecture, ecosystem) |

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not accurate. We do roll up in v2 feed, see CGA-5h9m-92rc-6gph where we have many affected entries corresponding to multiple advisories. It looks like we don't aggregate these intelligently though, it seems we just pick the first fix version we encounter (See https://github.com/chainguard-dev/mono/blob/26274fb41ff997a74507c8fa48d1d4e5e51900b4/lifecycle/secfeed/internal/feeds/osv/version/v2/v2.go#L230) so keeping it vague on "aggregates". This is one area v3 is different - there is actually no aggregation since its one entry per advisory / ecosystem

@tazinprogga tazinprogga left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, pending the edits I've suggested. Would also highly recommend getting a second set of Eng eyes to review.

Comment thread docs/osv_v2_feed.md Outdated
Comment thread docs/osv_v3_feed.md Outdated
Signed-off-by: Zackary Crosley <zackary.crosley@chainguard.dev>
@crosleyzack crosleyzack requested a review from tazinprogga June 23, 2026 17:01
@crosleyzack crosleyzack enabled auto-merge June 23, 2026 17:01
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.

2 participants