Repository navigation
--check-metaschema doesn't check $ref referenced schemas #464
Description
Considering the next json schema definition:
{
"title": "main.json"
"$id": "file://test-schemas/schemas/main.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"metadata"
],
"properties": {
"metadata": {
"additionalProperties": false,
"type": "object",
"required": [
"props1",
"props2"
],
"properties": {
"props1": {
"$ref": "/schemas/props1.json#/props"
},
"props2": {
"$ref": "/schemas/props2.json#/props"
}
}
}
}
}{
"title": "props1.json"
"$id": "/schemas/props1.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"props": {
"type": "object",
"required": [
"metadata"
],
"properties": {
"metadata": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"id"
],
"properties": {
"name": {
"type": "BADstring"
},
"id": {
"type": "integer"
}
}
}
}
}
}{
"title": "props2.json"
"$id": "/schemas/props2.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"props": {
"type": "object",
"required": [
"metadata"
],
"properties": {
"metadata": {
"additionalProperties": false,
"type": "object",
"required": [
"name",
"id"
],
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "integer"
}
}
}
}
}
}I'd like to be able to check fully recursively the schema main.json but it seems that check-jsonchema --check-metaschema main.json doesn't traverse references.
In this case, props1.json schema contains an error. "type" can't be "BADstring" (according to the metaschema". However, the check of main.json returns an ok -- validation done
Am I doing something wrong, there is a bug, or it is feature that could be proposed for enhancement?
thanks in advance!!
Activity
sirosen commentedon Jul 18, 2024
This is not expected to work in the way you were hoping, but I'm not sure if it's a feature request that I'd be willing to support/add.
Let me explain, and I'll have to take more time to think about the correct path forward.
Under the metaschema check, your schema is data being checked against a JSON Schema.
Conceptually, if every schema evaluation looks like
then we can translate the following two invocations thusly:
That is, it gets no special treatment, and normal JSON Schema checking rules apply. Since it's being evaluated as an ordinary document, there's no expectation that
$refs are followed. Ref resolution applies "when you are the schema", not "when you are the data".That explains why your
$refs aren't followed. It doesn't exactly help you do metaschema checking on the contents of those refs.I'm giving thought to whether or not following refs (opt-in?) would be appropriate for the metaschema check. It certainly would be nice and it makes perfect sense! But it also breaks the symmetry between normal schema evaluation and metaschema evaluation, and that makes me a little uneasy.
For right now, you can pull your
$refcontents manually and check them with the metaschema check as well. I know that's not what you're looking for, but it's the solution which is available today.rssh22 commentedon Jul 18, 2024
Hi @sirosen,
I understand your concerns about breaking the symmetry. I just can argue that from an schema developer point of view it would be very useful and it will simplify the metaschema validation both manually and in cicd pipelines :)
Whatever you decide,
Thank you so much