google / google/osv.dev

Desired API behaviour for queries with invalid/unknown ecosystems

Open
#5,523 0 comments 1 reaction 0 assignees View on GitHub
api backlog documentation
Dominant language
Go
Stars
2.9k
Forks
369
Avg merge
1d 17h
Merged PRs (30d)
149

Description

Currently, the OSV API:
- Returns an error if you query with an `ecosystem` not in the osv-schema
- Returns empty results (no error) if you do a `purl` query with a PURL type that we do not know
- Returns empty results if you query an ecosystem with an unknown (or invaid) suffix (e.g. `Debian:100`, `Alpine:foobar`, `npm:2`)
- (Usually) matches records of any ecosystem suffix even if a suffix is not provided and required (e.g. `Alpaquita` matches `Alpaquita:23`, `Alpaquita:25`, `Alpaquita:stream`, etc)

We should decide and document the behaviour we want, and make sure it's consistent.

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.