single geography template and generator

inline the reference to https://geojson.org/schema/FeatureCollection.json
in the template since we use it directly

Author: thekaveman

schema/geography.py

@@ -0,0 +1,32 @@
+"""
+Schema generators for Geography endpoints.
+"""
+
+import json
+
+import common
+
+
+def geography_schema():
+    """
+    Create the schema for the Geography endpoint.
+    """
+    # load schema template and insert definitions
+    schema = common.load_json("./templates/geography/geography.json")
+    definitions = common.load_definitions(
+        "string",
+        "timestamp",
+        "uuid",
+        "version"
+    )
+    definitions.update(common.load_definitions(
+        "timestamp",
+        "uuid_array",
+        allow_null=True
+    ))
+    schema["definitions"].update(definitions)
+
+    # verify and return
+    return common.check_schema(schema)
+
+

schema/templates/geography/geography.json

@@ -0,0 +1,86 @@
+{
+  "$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
+        }
+      }
+    }
+  },
+  "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
+}