Skip to content

Incorrect field name for "source" in OSV Scanner Results JSON Documentation #1391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
janniclas opened this issue Nov 9, 2024 · 1 comment · Fixed by #1398
Closed

Incorrect field name for "source" in OSV Scanner Results JSON Documentation #1391

janniclas opened this issue Nov 9, 2024 · 1 comment · Fixed by #1398
Labels
documentation Improvements or additions to documentation

Comments

@janniclas
Copy link
Contributor

The example JSON in the output documentation lists a field called packageSource (see linked markdown below).

"packageSource": {

However, the actual output I produce with the scanner and what I understand from the code (see linked code part below) the field name should be source.

Source SourceInfo `json:"source"`

I'm happy to create a PR for this if you confirm that this is indeed a typo :)

@michaelkedar
Copy link
Member

Oh wow, apparently that was changed ages ago and we never updated the example documentation (and I guess never updated that example output).

So yes - that's a mistake in the docs :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants