Merge branch '96-add-route-to-header' into '67-mas-dt'

Resolve "Add "route" optional field to header"

See merge request !58

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+- Route to header schema which shows the list of client_IDs relaying the message from the true source of message to final destination of it.
 - New message type "autonomy_engine_control". Long term plan is to integrate this as an object into the planning configuration schema, where if an operation has autonomy, the metadata, configurations, any instructions / default settings shall be within this message structure section.
 - Additional_data field to platform_status to input any other data from a platform to be published
 - Goal object in mission_plan message that consists of a GeoJSON feature (representing the part of primitive that is currently the goal of the given mission plan).

examples/mas-dt/mission_plan.json

@@ -5,6 +5,7 @@
     "version": 2,
     "source": "autonomy_engine",
     "destination": "soar.noc.autosub.alr-52.to_platform.mission_plan",
+    "route": ["proj-x-relay", "internal-relay"],
     "delivery_type": "publish",
     "encoded": false
   },

examples/mas-dt/planning_configuration.json

@@ -5,6 +5,7 @@
     "version": 2,
     "source": "noc-c2",
     "destination": "",
+    "route": ["proj-x-relay", "internal-relay"],
     "delivery_type": "broadcast",
     "encoded": false
   },

examples/mas-dt/platform_instruction_set.json

@@ -5,6 +5,7 @@
     "version": 1,
     "source": "ori",
     "destination": "mas-dt.noc.slocum.unit_111.to_platform.platform_instruction_set",
+    "route": ["proj-x-relay", "internal-relay"],
     "delivery_type": "publish",
     "encoded": false
   },

examples/mas-dt/platform_status_branch.json

@@ -5,6 +5,7 @@
         "version": "dev",
         "source": "noc-sfmc",
         "destination": "mas-dt.noc.slocum.unit_xxx.from_platform.platform_status",
+        "route": ["proj-x-relay", "internal-relay"],
         "delivery_type": "publish",
         "encoded": false
     },

examples/mas-dt/platform_status_commit.json

@@ -5,6 +5,7 @@
         "version": "2bbede2412f9038c0b1ecd8c2965532ea97264a3",
         "source": "noc-sfmc",
         "destination": "mas-dt.noc.slocum.unit_xxx.from_platform.platform_status",
+        "route": ["mas-dt-relay", "internal-relay"],
         "delivery_type": "publish",
         "encoded": false
     },

examples/mas-dt/platform_status_semver.json

@@ -5,6 +5,7 @@
         "version": "v2.0.0-beta.9",
         "source": "noc-sfmc",
         "destination": "mas-dt.noc.slocum.unit_xxx.from_platform.platform_status",
+        "route": ["proj-x-relay", "internal-relay"],
         "delivery_type": "publish",
         "encoded": false
     },

examples/mas-dt/waypoints_geojson.json

@@ -5,6 +5,7 @@
         "version": "v2.0.0-beta.1",
         "source": "noc-sfmc",
         "destination": "mas-dt.noc.slocum.unit_xxx.from_platform.waypoints",
+        "route": ["proj-x-relay", "internal-relay"],
         "delivery_type": "publish",
         "encoded": false
     },

examples/mas-dt/waypoints_props.json

@@ -5,6 +5,7 @@
         "version": "v2.0.0-beta.1",
         "source": "noc-sfmc",
         "destination": "mas-dt.noc.slocum.unit_xxx.from_platform.waypoints",
+        "route": ["proj-x-relay", "internal-relay"],
         "delivery_type": "publish",
         "encoded": false
     },

formats/header.py

+route_clients = {
+    "type": "string",
+    "description": "Client-ID",
+    "example": "proj-x-relay",
+}
+
 message_header = {
     "type": "object",
     "properties": {
@@ -25,6 +31,11 @@ message_header = {
             + " of this message",
             "example": "ah1",
         },
+        "route": {
+            "type": "array",
+            "items": route_clients,
+            "description": "Client-IDs of adapter between forwarding the message between the source adapter and destination adapter",
+        },
         "encoded": {
             "type": "boolean",
             "description": "Indicate that message raw (encoded) or decoded. "

project/soar/swagger.json

@@ -1502,6 +1502,15 @@
             "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
             "type": "string"
           },
+          "route": {
+            "description": "Client-IDs of adapter between forwarding the message between the source adapter and destination adapter",
+            "items": {
+              "description": "Client-ID",
+              "example": "proj-x-relay",
+              "type": "string"
+            },
+            "type": "array"
+          },
           "source": {
             "description": "The sender; Where is this message from",
             "example": "autonomy_engine",