JSONSchema Validation array items

Question

I receive the following items in a JSON Array

{locations: [{locId: "1", locName: "ST1"}, {locId: "2", locName: "ST2"}, {locId: "3", locName: "ST3"}]}

My requirement is that inside locations the value for locName has to be one of ST1, ST2, or ST3 (I don't care about locId). How do I enforce this in the JSONSchema. I saw you can use array but how do I specify that an object\item of the array should have one of the pre-defined values for a particular property.

Robby Cornelissen · Accepted Answer · 2019-09-17 06:03:22Z

1

You can use the enum keyword to restrict the allowed values for a given property:

"locName": {
  "type": "string",
  "enum": ["ST1", "ST2", "ST3"]
}

Complete schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "locations": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "locId": {
              "type": "string"
            },
            "locName": {
              "type": "string",
              "enum": ["ST1", "ST2", "ST3"]
            }
          },
          "required": [
            "locId",
            "locName"
          ]
        },        
      ]
    }
  },
  "required": [
    "locations"
  ]
}

edited Sep 17, 2019 at 6:03

answered Sep 17, 2019 at 5:54

Robby Cornelissen

98.6k23 gold badges154 silver badges180 bronze badges

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

Collectives™ on Stack Overflow

JSONSchema Validation array items

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related