geography.json

{
  "$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/geography/geography.json",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "The MDS Geography Schema",
  "type": "object",
  "definitions": {
    "geography": {
      "$id": "#/definitions/geography",
      "type": "object",
      "title": "The geography object schema",
      "additionalProperties": false,
      "required": [
        "name",
        "geography_id",
        "geography_json",
        "published_date"
      ],
      "properties": {
        "name": {
          "$id": "#/definitions/geography/properties/name",
          "$ref": "#/definitions/string",
          "description": "Name of geography"
        },
        "description": {
          "$id": "#/definitions/geography/properties/description",
          "$ref": "#/definitions/string",
          "description": "Description of geography"
        },
        "geography_type": {
          "$id": "#/definitions/geography/properties/geography_type",
          "type": "string",
          "description": "The type of geography"
        },
        "geography_id": {
          "$id": "#/definitions/geography/properties/geography_id",
          "$ref": "#/definitions/uuid",
          "description": "Unique ID of geography"
        },
        "geography_json": {
          "$id": "#/definitions/geography/properties/geography_json",
          "$ref": "https://geojson.org/schema/FeatureCollection.json",
          "description": "The GeoJSON FeatureCollection that defines the geographical coordinates"
        },
        "effective_date": {
          "$id": "#/definitions/geography/properties/effective_date",
          "$ref": "#/definitions/null_timestamp",
          "description": "The date at which a Geography is considered 'live'. Must be at or after published_date."
        },
        "published_date": {
          "$id": "#/definitions/geography/properties/published_date",
          "$ref": "#/definitions/timestamp",
          "description": "Timestamp at which the geography was published i.e. made immutable"
        },
        "retire_date": {
          "$id": "#/definitions/geography/properties/end_date",
          "$ref": "#/definitions/null_timestamp",
          "description": "Time that the geography is slated to retire. Once the retire date is passed, new policies can no longer reference it and old policies referencing it should be updated. Retired geographies should continue to be returned in the geographies list. Must be after effective_date."
        },
        "prev_geographies": {
          "$id": "#/definitions/geography/properties/prev_geographies",
          "$ref": "#/definitions/null_uuid_array",
          "description": "Unique IDs of prior geographies replaced by this one",
          "uniqueItems": true
        }
      }
    },
    "string": {
      "$id": "#/definitions/string",
      "type": "string",
      "description": "A length-limited string type",
      "maxLength": 255,
      "default": "",
      "examples": [
        "ABC123"
      ],
      "pattern": "^(.*)$"
    },
    "timestamp": {
      "$id": "#/definitions/timestamp",
      "type": "number",
      "description": "Integer milliseconds since Unix epoch",
      "multipleOf": 1.0,
      "minimum": 1514764800000
    },
    "uuid": {
      "$id": "#/definitions/uuid",
      "type": "string",
      "description": "A UUID used to uniquely identifty an object",
      "default": "",
      "examples": [
        "3c9604d6-b5ee-11e8-96f8-529269fb1459"
      ],
      "pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"
    },
    "version": {
      "$id": "#/definitions/version",
      "type": "string",
      "description": "The version of MDS this data represents",
      "examples": [
        "1.2.0"
      ],
      "pattern": "^1\\.2\\.[0-9]+$"
    },
    "uuid_array": {
      "$id": "#/definitions/uuid_array",
      "type": "array",
      "description": "Array of UUID",
      "items": {
        "$id": "#/definitions/uuid_array/items",
        "$ref": "#/definitions/uuid"
      }
    },
    "null_timestamp": {
      "$id": "#/definitions/null_timestamp",
      "type": [
        "number",
        "null"
      ],
      "description": "Integer milliseconds since Unix epoch",
      "multipleOf": 1.0,
      "minimum": 1514764800000
    },
    "null_uuid_array": {
      "$id": "#/definitions/null_uuid_array",
      "type": [
        "array",
        "null"
      ],
      "description": "Array of UUID",
      "items": {
        "$id": "#/definitions/uuid_array/items",
        "$ref": "#/definitions/uuid"
      }
    }
  },
  "required": [
    "geography",
    "version"
  ],
  "properties": {
    "geography": {
      "$id": "#/properties/geography",
      "$ref": "#/definitions/geography",
      "description": "The geography in this payload",
      "additionalProperties": false
    },
    "version": {
      "$id": "#/properties/version",
      "$ref": "#/definitions/version",
      "description": "The version of MDS that the geography represents"
    }
  },
  "additionalProperties": false
}