refactor telemetry props from vehicle props

these can be re-used in the new Feature geometry

Author: thekaveman

schema/agency.py

@@ -7,6 +7,16 @@
 import common
 
 
+def vehicle_telemetry():
+    telemetry = common.load_definitions("telemetry")
+    vehicle_telemetry = common.load_definitions("vehicle_telemetry")
+
+    # merge the standard telemetry props into vehicle_telemetry.gps
+    vehicle_telemetry["properties"]["gps"]["properties"].update(telemetry["properties"])
+
+    return vehicle_telemetry
+
+
 def get_stops_schema():
     """
     Create the schema for the Agency GET /stops endpoint.
@@ -113,10 +123,10 @@ def post_vehicle_event_schema():
     # load schema template and insert definitions
     schema = common.load_json("./templates/agency/post_vehicle_event.json")
     definitions = common.load_definitions(
-        "telemetry",
         "timestamp",
         "uuid"
     )
+    definitions["vehicle_telemetry"] = vehicle_telemetry()
     schema["definitions"].update(definitions)
 
     # merge the state machine definitions and transition combinations rule
@@ -139,10 +149,10 @@ def post_vehicle_telemetry_schema():
     # load schema template and insert definitions
     schema = common.load_json("./templates/agency/post_vehicle_telemetry.json")
     definitions = common.load_definitions(
-        "telemetry",
         "timestamp",
         "uuid"
     )
+    definitions["vehicle_telemetry"] = vehicle_telemetry()
     schema["definitions"].update(definitions)
 
     # verify and return

schema/templates/agency/post_vehicle_event.json

@@ -21,7 +21,7 @@
       "$ref": "#/definitions/timestamp"
     },
     "telemetry": {
-      "$ref": "#/definitions/telemetry"
+      "$ref": "#/definitions/vehicle_telemetry"
     },
     "trip_id": {
       "$ref": "#/definitions/uuid"

schema/templates/agency/post_vehicle_telemetry.json

@@ -11,7 +11,7 @@
     "data": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/telemetry"
+        "$ref": "#/definitions/vehicle_telemetry"
       }
     }
   },

schema/templates/common.json

@@ -307,71 +307,32 @@
     "telemetry": {
       "$id": "#/definitions/telemetry",
       "type": "object",
-      "description": "A vehicle telemetry datum",
-      "required": [
-        "device_id",
-        "timestamp",
-        "gps"
-      ],
+      "description": "A telemetry datum",
       "additionalProperties": false,
       "properties": {
-        "device_id": {
-          "$ref": "#/definitions/uuid"
+        "altitude": {
+          "type": "number",
+          "description": "Altitude above mean sea level in meters"
         },
-        "timestamp": {
-          "$ref": "#/definitions/timestamp"
+        "heading": {
+          "type": "number",
+          "description": "Degrees - clockwise starting at 0 degrees at true North"
         },
-        "gps": {
-          "type": "object",
-          "required": [
-            "lat",
-            "lng"
-          ],
-          "additionalProperties": false,
-          "properties": {
-            "lat": {
-              "type": "number",
-              "description": "Latitude of the location",
-              "minimum": -90,
-              "maximum": 90
-            },
-            "lng": {
-              "type": "number",
-              "description": "Longitude of the location",
-              "minimum": -180,
-              "maximum": 180
-            },
-            "altitude": {
-              "type": "number",
-              "description": "Altitude above mean sea level in meters"
-            },
-            "heading": {
-              "type": "number",
-              "description": "Degrees clockwise from true north"
-            },
-            "speed": {
-              "type": "number",
-              "description": "Speed in meters/sec"
-            },
-            "accuracy": {
-              "type": "number",
-              "description": "Accuracy in meters"
-            },
-            "hdop": {
-              "type": "number",
-              "description": "Horizontal GPS or GNSS accuracy value"
-            },
-            "satellites": {
-              "type": "integer",
-              "description": "Number of GPS or GNSS satellites"
-            }
-          }
+        "speed": {
+          "type": "number",
+          "description": "Estimated speed in meters / sec as reported by the GPS chipset"
         },
-        "charge": {
+        "accuracy": {
           "type": "number",
-          "description": "Fraction of charge of the vehicle (required if applicable",
-          "minimum": 0,
-          "maximum": 1
+          "description": "Horizontal accuracy, in meters"
+        },
+        "hdop": {
+          "type": "number",
+          "description": "Horizontal GPS or GNSS accuracy value"
+        },
+        "satellites": {
+          "type": "integer",
+          "description": "Number of GPS or GNSS satellites"
         }
       }
     },
@@ -677,6 +638,53 @@
         }
       ]
     },
+    "vehicle_telemetry": {
+      "$id": "#/definitions/vehicle_telemetry",
+      "type": "object",
+      "description": "A telemetry datum for a specific vehicle at a specific time",
+      "required": [
+        "device_id",
+        "timestamp",
+        "gps"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "device_id": {
+          "$ref": "#/definitions/uuid"
+        },
+        "timestamp": {
+          "$ref": "#/definitions/timestamp"
+        },
+        "gps": {
+          "type": "object",
+          "required": [
+            "lat",
+            "lng"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "lat": {
+              "type": "number",
+              "description": "Latitude of the location",
+              "minimum": -90,
+              "maximum": 90
+            },
+            "lng": {
+              "type": "number",
+              "description": "Longitude of the location",
+              "minimum": -180,
+              "maximum": 180
+            }
+          }
+        },
+        "charge": {
+          "type": "number",
+          "description": "Fraction of charge of the vehicle (required if applicable)",
+          "minimum": 0,
+          "maximum": 1
+        }
+      }
+    },
     "vehicle_type": {
       "$id": "#/definitions/vehicle_type",
       "type": "string",