JSON schema array required

Question

I'm trying to figure out how to set a global-level array required in schema. My example JSON file is:

[
    {
        "firstname": "Paul",
        "lastname": "McCartney"
    },
    {
        "firstname": "John",
        "lastname": "Lennon"
    },
    {
        "firstname": "George",
        "lastname": "Harrison"
    },
    {
        "firstname": "Ringo",
        "lastname": "Starr"
    }
]

As seen above, I want the top-level structure to be an array, not an object. The schema I've got from jsonschema.net is (with slight modifications):

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "/",
  "type": "array",
  "items": {
    "id": "elements",
    "type": "object",
    "properties": {
      "firstname": {
        "id": "firstname",
        "type": "string"
      },
      "lastname": {
        "id": "lastname",
        "type": "string"
      }
    },
    "required": [
      "firstname",
      "lastname"
    ]
  },
  "required": [
    "/"
  ]
}

But it fails with the jsonschema validator. Can you please help me with providing correct JSON schema for top-level array?

You don't need to make the top-level thing required. If the document is an array, then the document isn't optional! If you're trying to specify a minimum number of items, try minItems. — cloudfeet
– cloudfeet, Commented Mar 10, 2015 at 13:13

stefankmitph · Accepted Answer · 2015-03-10 12:32:38Z

5

To be valid with your input data you just need following schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "array",
    "id": "http://jsonschema.net",
    "items": {
        "type": "object",
        "properties": {
        "firstname": {
            "type": "string"
        },
        "lastname": {
            "type": "string"
        }
    },
    "required": [
        "firstname",
        "lastname"
    ]}
}

answered Mar 10, 2015 at 12:32

stefankmitph

3,3062 gold badges20 silver badges23 bronze badges

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

2 Comments

ducin Over a year ago

hmm, I get it - I had useless top-level required field defined. The array-element-level required is enough. Perfect, thanks!

mangusta Over a year ago

i am using check-jsonschema and required should be a field OF items, not on the same level WITH items

Collectives™ on Stack Overflow

JSON schema array required

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related