schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://raw.githubusercontent.com/dprgarner/tech-radar-generator/master/schema.json",
  "type": "object",
  "title": "Radar",
  "description": "The schema for the tech-radar-generator data.",
  "properties": {
    "title": {
      "type": "string",
      "description": "The title of the radar, which appears in the page title and the header of the page"
    },
    "quadrants": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of exactly four quadrant names in the radar, rendered anti-clockwise from the top-right",
      "minItems": 4,
      "maxItems": 4
    },
    "rings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of up to four names of rings in the radar, from inner-most to outer-most",
      "minItems": 1,
      "maxItems": 4
    },
    "blips": {
      "type": "array",
      "description": "An array of _blip_ objects determining the items appearing on the radar",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the blip"
          },
          "quadrant": {
            "type": "string",
            "description": "The quadrant of the radar that the blip appears in. There should be exactly four different quadrants in the full list of blips."
          },
          "ring": {
            "type": "string",
            "description": "The ring of the radar that the blip should appear in. This must take one of the provided ring values."
          },
          "isNew": {
            "type": "boolean",
            "description": "Set to true if the blip has been created or modified recently"
          },
          "description": {
            "type": "string",
            "description": "A short description of the blip which appears when the blip is selected in the radar. This field can include HTML, and should include links to any supporting information or resources about the blip, and an explanation of why it's classified in the current ring."
          }
        },
        "required": ["name", "quadrant", "ring", "isNew", "description"],
        "additionalProperties": false
      }
    }
  },
  "required": ["title", "quadrants", "rings", "blips"],
  "additionalProperties": false
}