Resolve "Test validating messages with references to GeoJson schema in both JS and python"

Closes #45 (closed)

examples/autonomy_engine_adapter/planning_configuration.json

     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "gui",
-    "destination": "soar.all.all.all.from_platform.planning_configuration",
+    "destination": "",
     "delivery_type": "broadcast",
     "encoded": false
   },
     "planning_config_ID": 1,
     "exclusion_zones": [
       {
-        "geometry_coordinates": [
+        "type": "Polygon", 
+        "coordinates": [
           [
             [
               -4.1777839187560915,
     ],
     "region_of_interest": [
       {
-        "geometry_coordinates": [
+        "type": "Polygon", 
+        "coordinates": [
           [
             [
               -4.1777839187560915,

examples/gui_adapter/planning_configuration.json

     "timestamp": "2022-11-16T00:00:00Z",
     "version": 2,
     "source": "gui",
-    "destination": "soar.all.all.all.from_platform.planning_configuration",
-    "delivery_type": "publish",
+    "destination": "",
+    "delivery_type": "broadcast",
     "encoded": false
   },
   "payload":{
     "planning_config_ID": 1,
     "exclusion_zones": [
       {
-        "geometry_coordinates": [
+        "type": "Polygon", 
+        "coordinates": [
           [
             [
               -4.1777839187560915,
     ],
     "region_of_interest": [
       {
-        "geometry_coordinates": [
+        "type": "Polygon", 
+        "coordinates": [
           [
             [
               -4.1777839187560915,

formats/planning_configuration.py

     "required": [
         "target_waypoint_latitude",
         "target_waypoint_longitude",
-        "target_depth",
     ],
 }
 
     ],
 }
 
-region_schema = {
-    "type": "object",
-    "properties": {
-        "geometry_coordinates": {
-            "type": "array",
-            "example": [
-                [
-                    [-4.1777839187560915, 50.34173405662855],
-                    [-4.1777839187560915, 50.33820949229701],
-                    [-4.143667777943875, 50.33820949229701],
-                    [-4.143667777943875, 50.34173405662855],
-                    [-4.1777839187560915, 50.34173405662855],
-                ]
-            ],
-        },
-    },
-    "description": "Using GEOJSON, exact 4-point region (rectangle shaped - 5 points)",
-}
-
 squad_metadata_schema = {
     "type": "object",
     "properties": {
         },
         "region_of_interest": {
             "type": "array",
-            "items": region_schema,
+            "items": {
+                "$ref": "https://geojson.org/schema/Polygon.json",
+            },
             "description": "Region of interest for the entire operation",
         },
         "exclusion_zones": {
             "type": "array",
-            "items": region_schema,
+            "items": {
+                "$ref": "https://geojson.org/schema/Polygon.json",
+            },
             "description": "Exclusion zones for all platforms",
         },
         "squads": {

tests/test_schemas.py

-from openapi_spec_validator import openapi_v30_spec_validator
+from openapi_spec_validator import OpenAPIV30SpecValidator
 from openapi_spec_validator.readers import read_from_filename
 from openapi_schema_validator import validate
 from jsonschema.validators import RefResolver
 import unittest
 import json
 import os
-from generate_schema_config import write_schema, swagger_config
+from generate_schema_config import write_schema, get_swagger_config
 
 
 MOCK_DATA_DIR = "examples/"
     def setUpClass(cls):
         test_schema_path = "tests/test_swagger.json"
         os.environ["SCHEMA_PATH"] = test_schema_path
+        swagger_config = get_swagger_config()
         write_schema(swagger_config, test_schema_path)
 
 
         """
         print("TEST: compiled schema matches openapi v3 spec")
         schema = self.load_schema()
-        self.assertIsNone(openapi_v30_spec_validator.validate(schema))
+        errors = list(OpenAPIV30SpecValidator(schema).iter_errors())
+        self.assertEqual(len(errors), 0)
 
 
 class TestAllMessageExamples(SchemaTestCase):

[Dan Jones]

This is the experiment I did during the design sprint with compiling the geojson schemas into the backbone message format at build time so messages can be compiled against local refs derived from the published geojson schemas.

[Dan Jones]

GeoJSON Point accepts a minimum of 2 coordinates but sets no maximum.

If we use GeoJSON Point to specify lat/long do we want to include altitude/depth and if so do we just have a convention that says [x(long), y(lat), z(depth), a(?)(altitude)] so you can provide points as 2D, 3D, or 4D as required?

Alternatively do we just use GeoJSON Point for lat/long and keep depth/altitude as separate named parameters? Or do we have a 3D Point [x,y,z] with a parameter that says whether z refers to depth or altitude?

[Dan Jones]

Hmm - Importing the individual geographies works OK but for some reason importing the Feature or FeatureCollection schemas fails and I can't immediately see why.

We can probably do without FeatureCollection but I think we need Feature for the primitive list because we want primitives to accept different geometry types.

So far I've removed $id and $schema from the published schemas

I think removing properties that don't alter the structure or validation of the data is probably fine. I might be able to make Feature work with a bit more of that.

If I have to do anything else to make Feature work then I think it needs a different answer.

[Dan Jones]

This is a bug with our current pinned version of openapi-spec-validator and can be fixed by upgrading the package.