Skip to content

Commit

Permalink
docs: corrected field names in osv scanner results in the JSON doc (#…
Browse files Browse the repository at this point in the history
…1398)

Corrected JSON field names in the osv-scanner documentation. Previously,
one key was incorrectly called `sourcePackage` and was changed to
`source`.

Closes #1391

Co-authored-by: Holly Gong <39108850+hogo6002@users.noreply.github.com>
  • Loading branch information
janniclas and hogo6002 authored Nov 14, 2024
1 parent a8b7c34 commit c80f395
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ osv-scanner --format json -L path/to/lockfile > /path/to/file.json
{
"results": [
{
"packageSource": {
"source": {
"path": "/absolute/path/to/go.mod",
// One of: lockfile, sbom, git, docker
"type": "lockfile"
Expand Down Expand Up @@ -148,7 +148,7 @@ osv-scanner --format json -L path/to/lockfile > /path/to/file.json
]
},
{
"packageSource": {
"source": {
"path": "/absolute/path/to/Cargo.lock",
"type": "lockfile"
},
Expand Down

0 comments on commit c80f395

Please sign in to comment.