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

External property file schema contains broken $ref's #417

Closed
kupsch opened this issue May 16, 2019 · 0 comments
Closed

External property file schema contains broken $ref's #417

kupsch opened this issue May 16, 2019 · 0 comments
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. bug merged Changes merged into provisional draft. resolved-fixed

Comments

@kupsch
Copy link

kupsch commented May 16, 2019

@lgolding @michaelcfanning

We tried to validate the external properties file and ran into problems.

All the '$ref' values in the sarif-external-property-file-schema.json JSON Schema file start with

This is clearly not correct. It does not exist, the file name is incorrect, and it should be relative. A better value to begin each '$ref' with would be a relative URI, so if both schemas are in the same URI directory path everything should just work:

  • sarif-schema.json

Both JSON Schema files should probably have the version of SARIF in their names also.

The SARIF document has '$schema' values of 'http://json.schemastore.org/sarif-2.1.0' and 'http:///json.schemastore.org/sarif-external-property-file-2.1.0'. These documents do not exist. It would be better to have the official schema URI be an OASIS hosted site (unless OASIS recommends the schema store), and the final component should match the name in the spec repo currently 'sarif-schema.json' (should be 'sarif-schema-2.1.0.json' on final publication). I don't think that the spec should rely upon an external web site for the official $schema URL as it could disappear, and then there is the question of administrative control of the schema files hosted there. The schemas can on the site, but shouldn't the URL used in the spec.

If there are official schema URIs, the official OASIS URIs for SARIF schemas and the SARIF external property file schemas should be stated in the document, they are only in examples currently.

@ghost ghost self-assigned this May 17, 2019
@ghost ghost added bug 2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. resolved-fixed merged Changes merged into provisional draft. labels May 17, 2019
@ghost ghost closed this as completed May 20, 2019
@ghost ghost changed the title external file scheme broken $ref's External property file schema contains broken $ref's May 20, 2019
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. bug merged Changes merged into provisional draft. resolved-fixed
Projects
None yet
Development

No branches or pull requests

1 participant