Issue with schema validation

[boris-ning-usds]

Hi,

My name is Boris Ning, and I'm the implementation engineer for Centers for Disease Control & Prevention (CDC)'s ShareIT Act.

I'm trying to figure out some alignment of fields for code.json, and ran into some difficulties validating my code.json; I figured that I should run some examples with the setup provided and couldn't get it working either.
Do you have a better way of validating against the provided schema quickly?

What I've tried

I'm using both this website and the jsonschema CLI tool on the schema-1.0.0.json and code.json, both files within this repository.

The website for jsonschemavalidator.net doesn't seem to think "description" is a properties.item field, so that parser is probably wrong. I also tried with the jsonschema tool, and I ran into issues parsing the code.json provided...

jsonschema validate schema-1.0.0.json code.json

The output:

fail: /home/distro/Downloads/code.json
error: Schema validation failure
  The value was expected to be an object that defines properties "categories", "contact", "contractNumber", "date", "description", "feedbackMechanisms", "laborHours", "languages", "localisation", "longDescription", "maintenance", "name", "organization", "permissions", "platforms", "repositoryURL", "repositoryVisibility", "reuseFrequency", "softwareType", "status", "tags", and "vcs"
    at instance location ""
    at evaluate path "/required"

Will there be a schema json file for the array version of code.json that agencies should produce at the top level; since this schema.json is intended for single repository code.json.

Thank you!
-Boris

[natalialuzuriaga]

Hi Boris,

Thank you for flagging this!

You’re right —the initial code.json schema was not valid which I completely overlooked while making my updates. As a result, I have incorporated the use of the jsonschema CLI tool into our PR checks to validate the schema going forward as we make more updates. We also plan to incorporate schema validation to our SHARE IT tools like codejson-generator, automated-codejson-generator, and index-generator.

After a series of updates, we shipped our latest version of the code.json schema: https://github.com/DSACMS/gov-codejson/blob/main/schemas/schema-2.0.0.json

Regarding the json file that agencies should produce at the top level, this would be the agency-index.json file. Here are the docs for this where you can find more information including its schema. Agencies create the index file which contains an array of repository-level code.jsons.

Thank you for your feedback, it has helped a ton as I upkeep this repository. Let me know if you have any other questions and feedback!

Natalia

[natalialuzuriaga]

For reference, the following PRs address this issue:

• Workflows: Create json-validate.yml #24
• Added Tests + Schema Updates #33
• Docs: Added agency-index.md #37
• Add agency-index schema #39

[boris-ning-usds]

Thank you for resolving this. Feel free to close as needed.

I ran check-jsonschema against code.json with the schema-2.0.0.json and it works.

check-jsonschema --schemafile schemas/schema-2.0.0.json code.json

output:

ok -- validation done

[natalialuzuriaga]

Awesome, thank you!