schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/ParkenDD/ParkAPI2/raw/master/web/scrapers/builtin/schema.json",

  "title": "ParkAPI2 scraper snapshot layout",
  "description": "The JSON that is digested by the ParkAPI database",

  "type": "object",
  "required": ["pool", "lots"],

  "properties": {
    "pool": {"$ref": "#/definitions/pool"},

    "lots": {
      "type": "array",
      "items": {"$ref": "#/definitions/lot"}
    }
  },

  "definitions": {

    "pool": {
      "title": "Parking pool",
      "description": "Description of the source of scraped parking data",
      "type": "object",

      "required": [
        "id", "name", "public_url", "timezone"
      ],

      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "pattern": "^[a-z0-9\\-]+$"
        },
        "name": {
          "type": "string",
          "maxLength": 64
        },
        "public_url": {
          "type": "string",
          "maxLength": 4096,
          "pattern": "^[a-z]+://.+"
        },
        "source_url": {
          "type": ["string", "null"],
          "maxLength": 4096,
          "pattern": "^[a-z]+://.+"
        },
        "timezone": {
          "type": "string",
          "maxLength": 64,
          "description": "This is only used by the scraper to correctly parse datetime strings"
        },
        "attribution_license": {
          "type": ["string", "null"]
        },
        "attribution_contributor": {
          "type": ["string", "null"],
          "maxLength": 128
        },
        "attribution_url": {
          "type": ["string", "null"],
          "maxLength": 4096,
          "pattern": "[a-z]+://.+"
        }
      }
    },

    "lot": {
      "title": "Parking Lot",
      "description": "Description of the parking lot data",
      "required": [
        "id", "name", "type", "status", "source_url",
        "has_live_capacity"
      ],
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 64,
          "pattern": "^[a-z0-9\\-æøé]+$"
        },
        "name": {
          "type": "string",
          "maxLength": 64
        },
        "type": {
          "type": "string",
          "maxLength": 32,
          "pattern": "lot|garage|underground|level|street|bus|unknown"
        },
        "public_url": {
          "type": ["string", "null"],
          "maxLength": 4096,
          "pattern": "^[a-z]+://.+"
        },
        "source_url": {
          "type": "string",
          "maxLength": 4096,
          "pattern": "^[a-z]+://.+"
        },
        "address": {
          "type": ["string", "null"],
          "maxLength": 1024
        },
        "latitude": {
          "type": ["number", "null"]
        },
        "longitude": {
          "type": ["number", "null"]
        },
        "has_live_capacity": {
          "type": "boolean"
        },
        "capacity": {
          "type": ["integer", "null"]
        },
        "num_free": {
          "type": ["integer", "null"]
        },
        "timestamp": {
          "type": "string",
          "pattern": "\\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d"
        },
        "lot_timestamp": {
          "type": ["string", "null"],
          "pattern": "\\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d"
        },
        "num_occupied": {
          "type": ["integer", "null"]
        },
        "status": {
          "type": "string",
          "pattern": "open|closed|unknown|nodata|error"
        }
      }
    }
  }
}