Skip to content
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

Document the structure of ScanCode's JSON output #617

Closed
jdaguil opened this issue May 15, 2017 · 2 comments
Closed

Document the structure of ScanCode's JSON output #617

jdaguil opened this issue May 15, 2017 · 2 comments

Comments

@jdaguil
Copy link
Contributor

jdaguil commented May 15, 2017

There should be documentation for the ScanCode structure in the JSON output. Sometimes it's difficult to know what the data types are for the output.

For example, when the value is null or an empty array:

"date": null,
"mime_type": null,
"scan_errors": [],
"copyrights": [
        {
          "statements": [
            "Copyright (c) 2002-2004 Dmitriy Anisimkov"
          ],
          "holders": [
            "Dmitriy Anisimkov"
          ],
          "authors": [],
          "start_line": 4,
          "end_line": 4
        }
@pombredanne
Copy link
Contributor

pombredanne commented May 25, 2017

I generated some JSON schema from schematics for ScanCode... I will commit this later though let me paste these here for now.

json-schemas.zip

pombredanne added a commit that referenced this issue May 25, 2017
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Copy link
Contributor

https://github.com/nexB/scancode-toolkit/tree/develop/etc/scripts/sch2js now contains a script and generated JSON schema for the Package models.

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

No branches or pull requests

2 participants