oss/syft
2
0
Fork 0
mirror of https://github.com/anchore/syft.git synced 2025-11-17 16:33:21 +01:00
Code Issues Packages Projects Releases Wiki Activity
syft/schema
History
Alex Goodman f46de19c6b
migrate scope option to image metadata (from source) 
Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
2020-11-17 12:37:12 -05:00
..
cyclonedx
add bom descriptor schema + test against xml schemas in pipeline (#163)
2020-08-27 19:12:45 -04:00
json
migrate scope option to image metadata (from source)
2020-11-17 12:37:12 -05:00
README.md
Add support for package.json #200
2020-10-16 11:28:54 -04:00

README.md

Updating the JSON schema

Today the JSON schema is generated from integration test data. Specifically, when integration tests are run, the /schema/json/examples directory is populated with syft JSON output data. This examples directory is used to drive automatically generating the JSON schema. The caveats with this approach is:

  1. the JSON schema is only as good as the examples provided
  2. there is an integration test that ensures that the JSON schema is valid relative to what the code currently generates. This means to update the JSON schema you need to
  3. Open up test/integration/json_schema_test.go and comment out invocations of the validateAgainstV1Schema function.
  4. From the root of the repo run generate-json-schema. Now there should be a new schema generated at /schema/json/schema.json
  5. Uncomment the validateAgainstV1Schema function.