Merge branch '17-update-acknowledgment-schema' into 'dev'

Resolve "Update acknowledgment schema"

Closes #17

See merge request !6

examples/autonomy_engine_adapter/acknowledgement.json

@@ -10,7 +10,8 @@
     },
     "payload":{
         "message_type": "acknowledgement",
-        "acknowledged_message_ID": "11111111-7bc8-11ed-a1eb-0242ac999999",
-        "status": "c2_received"
+        "autonomy_engine_plan_ID": 1,
+        "platform_ID": "reav-x-1",
+        "approved": false
     }
 }
\ No newline at end of file

examples/hydrosurv_adapter/acknowledgement.json

@@ -10,7 +10,8 @@
     },
     "payload":{
         "message_type": "acknowledgement",
-        "acknowledged_message_ID": "11111111-7bc8-11ed-a1eb-0242ac999999",
-        "status": "c2_received"
+        "autonomy_engine_plan_ID": 1,
+        "platform_ID": "reav-x-1",
+        "approved": false
     }
 }
\ No newline at end of file

formats/acknowledgement.py

@@ -10,21 +10,27 @@ acknowledgement_schema = {
             "description": "Type of message",
             "example": "acknowledgement",
         },
-        "acknowledged_message_ID": {
-            "type": "string",
-            "description": "Identifier of message received and executed with "
-            + "success for mission plans sent by the Autonomy Engine.",
-            "example": "02125022255-7bc8-11ed-a1eb-0242ac999999",
+        "autonomy_engine_plan_ID": {
+            "type": "integer",
+            "description": "Mission plan ID (according to Autonomy"
+            + " Engine's mission plan number sent) executed by platform",
+            "example": 1,
         },
-        "status": {
+        "platform_ID": {
             "type": "string",
-            "enum": ["c2_received", "operator_approved_and_sent", "executed"],
-            "description": "Highest level of acknowledgement. I.e."
-            + " `c2_received`: Received by C2, `operator_approved_and_sent`"
-            + " : Approved by operator and sent from C2->Platform,"
-            + " `executed`: Executed by platform",
-            "example": "executed by platform",
+            "description": "Unique identifier for this platform",
+            "example": "reav-x-1",
+        },
+        "approved": {
+            "type": "boolean",
+            "description": "Human-in-the-loop approval."
+            + "1 - Plan approved; 0 - Plan Rejected",
         },
     },
-    "required": ["message_type", "acknowledged_message_ID", "status"],
+    "required": [
+        "message_type",
+        "autonomy_engine_plan_ID",
+        "platform_ID",
+        "approved",
+    ],
 }

project/soar/swagger.json

@@ -19,31 +19,32 @@
       },
       "acknowledgement": {
         "properties": {
-          "acknowledged_message_ID": {
-            "description": "Identifier of message received and executed with success for mission plans sent by the Autonomy Engine.",
-            "example": "02125022255-7bc8-11ed-a1eb-0242ac999999",
-            "type": "string"
+          "approved": {
+            "type": "boolean",
+            "description": "Human-in-the-loop approval. 1 - Plan approved; 0 - Plan Rejected",
+            "example": 1
+          },
+          "autonomy_engine_plan_ID": {
+            "type": "integer",
+            "description": "Mission plan ID (according to Autonomy Engine's mission plan number sent) executed by platform",            
+            "example": 1
           },
           "message_type": {
             "description": "Type of message",
-            "example": "acknowledgement",
-            "type": "string"
+            "type": "string",
+            "example": "acknowledgement"
           },
-          "status": {
-            "description": "Highest level of acknowledgement. I.e. `c2_received`: Received by C2, `operator_approved_and_sent` : Approved by operator and sent from C2->Platform, `executed`: Executed by platform",
-            "enum": [
-              "c2_received",
-              "operator_approved_and_sent",
-              "executed"
-            ],
-            "example": "executed by platform",
-            "type": "string"
+          "platform_ID": {
+            "type": "string",
+            "description": "Unique identifier for this platform",
+            "example": "reav-x-1"
           }
         },
         "required": [
           "message_type",
-          "acknowledged_message_ID",
-          "status"
+          "autonomy_engine_plan_ID",
+          "platform_ID",
+          "approved"
         ],
         "type": "object"
       },
@@ -242,8 +243,7 @@
           },
           "region_surveyed": {
             "description": "Region surveyed by given platform. GEOJSON",
-            "example": "",
-            "nullable": true
+            "example": ""
           }
         },
         "required": [
@@ -523,9 +523,9 @@
             "type": "number"
           },
           "depth": {
-            "default": 0,
+            "default": 0.0,
             "description": "Target depth in metres",
-            "example": 50,
+            "example": 50.0,
             "format": "float",
             "type": "number"
           },

tests/fixtures/schemas.py

@@ -56,23 +56,29 @@ acknowledgement_schema = {
             "description": "Type of message",
             "example": "acknowledgement",
         },
-        "acknowledged_message_ID": {
-            "type": "string",
-            "description": "Identifier of message received and executed with "
-            + "success for mission plans sent by the Autonomy Engine.",
-            "example": "02125022255-7bc8-11ed-a1eb-0242ac999999",
+        "autonomy_engine_plan_ID": {
+            "type": "integer",
+            "description": "Mission plan ID (according to Autonomy"
+            + " Engine's mission plan number sent) executed by platform",
+            "example": 1,
         },
-        "status": {
+        "platform_ID": {
             "type": "string",
-            "enum": ["c2_received", "operator_approved_and_sent", "executed"],
-            "description": "Highest level of acknowledgement. I.e."
-            + " `c2_received`: Received by C2, `operator_approved_and_sent`"
-            + " : Approved by operator and sent from C2->Platform,"
-            + " `executed`: Executed by platform",
-            "example": "executed by platform",
+            "description": "Unique identifier for this platform",
+            "example": "reav-x-1",
+        },
+        "approved": {
+            "type": "boolean",
+            "description": "Human-in-the-loop approval. "
+            + "1 - Plan approved; 0 - Plan Rejected",
         },
     },
-    "required": ["message_type", "acknowledged_message_ID", "status"],
+    "required": [
+        "message_type",
+        "autonomy_engine_plan_ID",
+        "platform_ID",
+        "approved",
+    ],
 }
 
 
@@ -509,7 +515,7 @@ platform_status_schema = {
             "format": "float",
             "description": "Target depth in metres",
             "example": 50.0,
-            "default": 0,
+            "default": 0.0,
         },
         "altitude": {
             "type": "number",

tests/fixtures/swagger.json

@@ -19,31 +19,32 @@
       },
       "acknowledgement": {
         "properties": {
-          "acknowledged_message_ID": {
-            "description": "Identifier of message received and executed with success for mission plans sent by the Autonomy Engine.",
-            "example": "02125022255-7bc8-11ed-a1eb-0242ac999999",
-            "type": "string"
+          "approved": {
+            "type": "boolean",
+            "description": "Human-in-the-loop approval. 1 - Plan approved; 0 - Plan Rejected",
+            "example": 1
+          },
+          "autonomy_engine_plan_ID": {
+            "type": "integer",
+            "description": "Mission plan ID (according to Autonomy Engine's mission plan number sent) executed by platform",            
+            "example": 1
           },
           "message_type": {
             "description": "Type of message",
-            "example": "acknowledgement",
-            "type": "string"
+            "type": "string",
+            "example": "acknowledgement"
           },
-          "status": {
-            "description": "Highest level of acknowledgement. I.e. `c2_received`: Received by C2, `operator_approved_and_sent` : Approved by operator and sent from C2->Platform, `executed`: Executed by platform",
-            "enum": [
-              "c2_received",
-              "operator_approved_and_sent",
-              "executed"
-            ],
-            "example": "executed by platform",
-            "type": "string"
+          "platform_ID": {
+            "type": "string",
+            "description": "Unique identifier for this platform",
+            "example": "reav-x-1"
           }
         },
         "required": [
           "message_type",
-          "acknowledged_message_ID",
-          "status"
+          "autonomy_engine_plan_ID",
+          "platform_ID",
+          "approved"
         ],
         "type": "object"
       },

tests/mock_data/autonomy_engine_adapter/acknowledgement.json

@@ -10,7 +10,8 @@
     },
     "payload":{
         "message_type": "acknowledgement",
-        "acknowledged_message_ID": "11111111-7bc8-11ed-a1eb-0242ac999999",
-        "status": "c2_received"
+        "autonomy_engine_plan_ID": 1,
+        "platform_ID": "reav-x-1",
+        "approved": false
     }
 }
\ No newline at end of file

tests/mock_data/hydrosurv_adapter/acknowledgement.json

@@ -10,7 +10,8 @@
     },
     "payload":{
         "message_type": "acknowledgement",
-        "acknowledged_message_ID": "11111111-7bc8-11ed-a1eb-0242ac999999",
-        "status": "c2_received"
+        "autonomy_engine_plan_ID": 1,
+        "platform_ID": "reav-x-1",
+        "approved": false
     }
 }
\ No newline at end of file