Json Schema Properties with $ref

Question

Trying to use $ref for the entirety of properties. I can't tell what this is syntax valid but doesn't validate the payload. This should fail but doesn't.

I've also tried "$ref": "file:./ref.json".

schema:

{
  "animal": {
    "properties":{
      "allOf": {"$ref": "file:./ref.json"}
    }
  },
  "required": ["animal"]
}

ref.json:

{
    "action":{
        "type": "string"
        },
    "required": ["action"]
}

payload

{
    "animal": {
        "action": 2
    }
}

It looks like you're new to JSON Schema. I suggest json-schema.org/learn/getting-started-step-by-step.html for a really quick intro and json-schema.org/understanding-json-schema for a gentle, but deeper dive. — Jason Desrosiers
– Jason Desrosiers, Commented Sep 28, 2021 at 22:43

Ether · Accepted Answer · 2021-09-28 16:30:04Z

1

"allOf": {"$ref": "file:./ref.json"} is not syntactically valid -- the value of an allOf must be an array. (your evaluator should be giving you a warning about this.)
JSON Schema evaluators are not required to support loading external files from disk or the network. Check your documentation for how to add documents to the evaluator so they can be used by $ref. (your evaluator should be giving you a warning when you reference an unknown resource.)

The reason why you are not seeing the above errors is because your overall schema has no recognized keywords in it -- you are missing a "properties": { ... } wrapped around the entire schema. The top level "keyword" is "animal", which is not recognized, therefore there are no recognized keywords anywhere in the schema, therefore there is nothing to make it return an invalid result.

answered Sep 28, 2021 at 16:30

Ether

54.2k13 gold badges91 silver badges162 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Secret Sauce Over a year ago

Thank you for clarifying the top level keyword issue. As for the file, it's a local file in the same folder as the schema (Win10). However, with the properties added, it still resolves with no issues. ``` { "properties": { "animal": { "type": "object", "properties":{ "allOf": {"$ref": "file:./ref.json"} } } }, "required": ["animal"] } ```

Secret Sauce Over a year ago

Is this perhaps an issue of how Draft-7 uses $ref? As with the following, the second value works but not ideal for what I'm looking for. "$ref": "ref.json", "action":{"$ref": "ref.json"}

Relequestual Over a year ago

You cann't use $ref in a non-schema object in JSON Schema. I you want to show an updated JSON Schema given part of the answer here, it's best you add to your question. Adding code in comments here is not very useful.

Ether Over a year ago

You're still missing the wrapping list around the contents of allOf, as noted in the first bullet.

Collectives™ on Stack Overflow

Json Schema Properties with $ref

1 Answer 1

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related