Skip to content

docs: need documentation on fields in output JSON #118

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

Open
lucasgonze opened this issue May 6, 2025 · 1 comment
Open

docs: need documentation on fields in output JSON #118

lucasgonze opened this issue May 6, 2025 · 1 comment
Assignees

Comments

@lucasgonze
Copy link
Contributor

Problem: the meaning of the output JSON can be obscure. Documentation on what the fields mean would be helpful.

Details: The attached screenshot is ScanOSS output JSON for the open source project react-hook-form. It says there is a 100% match, but with what isn't stated.

Image

@ortizjeronimo
Copy link
Contributor

Hi @lucasgonze ,

Let me share a description of every field in the JSON output provided by our tools:

  • key - Local file name
  • Component - Component name
  • file - Matched file name
  • file_hash - MD5 sum of matched file
  • file_url - Url of matched file
  • id - Match type: File or Snippet on None
  • lastest - Latest mined version of matched component
  • lines - Matched snippet line ranges. If id ="file" then lines = "all"
  • purl - List of purls for the matched component
  • release_date - Matched component release date
  • server - Server information
  • kb_version - Knowledge base version information
  • daily - Date of the daily knowledge base update
  • monthly - Date of the monthly knowledge base update
  • version - Version of the knowledge base
  • source_hash - MD5 sum of the local file
  • status - Status of the matched component
  • url - Url of the remote location of the matched component
  • url_hash - MD5 sum of the remote url
  • vendor - Component vendor
  • version - Detected version of the matched component

Let me know if you have any additional questions, I'll be glad to help.

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

No branches or pull requests

2 participants