Added the topic property to messages (#15)

mjeras · web-flow · commit ed3df2fb8d06 · 2018-11-16T07:08:51.000Z
Schemas have been updated to match the documentation changes
diff --git a/APIs/schemas/event_core.json b/APIs/schemas/event_core.json
@@ -28,6 +28,11 @@
           "description": "ID of the source that holds the state that has changed",
           "type": "string",
           "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "flow_id": {
+          "description": "ID of the flow carrying the message",
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
         }
       }
     },
diff --git a/APIs/schemas/message_connection_lost.json b/APIs/schemas/message_connection_lost.json
@@ -25,6 +25,11 @@
           "description": "ID of the source which identifies the emitter of the event",
           "type": "string",
           "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "flow_id": {
+          "description": "ID of the flow carrying the message",
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
         }
       }
     }
diff --git a/APIs/schemas/message_shutdown_reboot.json b/APIs/schemas/message_shutdown_reboot.json
@@ -26,6 +26,11 @@
           "description": "ID of the source which identifies the emitter of the event",
           "type": "string",
           "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "flow_id": {
+          "description": "ID of the flow carrying the message",
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
         }
       }
     },
diff --git a/APIs/schemas/receiver_transport_params_ext.json b/APIs/schemas/receiver_transport_params_ext.json
@@ -0,0 +1,24 @@
+{
+  "$id": "https://www.amwa.tv/event_and_tally/receiver_transport_params_ext.json",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Describes external Sender transport parameters defined for IS-07 NMOS Event & Tally specification. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint.",
+  "title": "External Sender Transport Parameters",
+  "type": "object",
+  "properties": {
+    "ext_is_07_rest_api_url": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "the event and tally rest api url targeting the associated source"
+    },
+    "ext_is_07_source_id": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "ID of the related source",
+      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+    }
+  }
+}
diff --git a/APIs/schemas/sender_transport_params_ext.json b/APIs/schemas/sender_transport_params_ext.json
@@ -0,0 +1,18 @@
+{
+  "$id": "https://www.amwa.tv/event_and_tally/sender_transport_params_ext.json",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Describes external Sender transport parameters defined for IS-07 NMOS Event & Tally specification. The constraints in this schema are minimum constraints, but may be further constrained at the constraints endpoint.",
+  "title": "External Sender Transport Parameters",
+  "type": "object",
+  "properties": {
+    "ext_is_07_rest_api_url": {
+      "type": "string",
+      "description": "the event and tally rest api url targeting the associated source"
+    },
+    "ext_is_07_source_id": {
+      "type": "string",
+      "description": "ID of the related source",
+      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+    }
+  }
+}
diff --git a/examples/connectionapi-v1.1-receiver-active-get-mqtt-200.json b/examples/connectionapi-v1.1-receiver-active-get-mqtt-200.json
@@ -0,0 +1,21 @@
+{
+  "sender_id": "eae33112-b56c-4a36-8b68-05ab5b6268bc",
+  "master_enable": true,
+  "activation": {
+    "mode": "activate_immediate",
+    "requested_time": "1541508905:0",
+    "activation_time": "1541508905:263900"
+  },
+  "transport_file": {
+    "data": null,
+    "type": null
+  },
+  "transport_params": [
+    {
+      "source_host": "broker.mydomain.com",
+      "source_port": 1883,
+      "broker_topic": "my_topic_name",
+      "ext_is_07_rest_api_url": "http://hostname/x-nmos/events/v1.0/sources/6cbd0441-7882-44cd-9557-842243a0d618",
+    }
+  ]
+}
diff --git a/examples/connectionapi-v1.1-receiver-active-get-websocket-200.json b/examples/connectionapi-v1.1-receiver-active-get-websocket-200.json
@@ -0,0 +1,18 @@
+{
+  "sender_id": "eae33112-b56c-4a36-8b68-05ab5b6268bc",
+  "master_enable": true,
+  "activation": {
+    "mode": "activate_immediate",
+    "requested_time": "1541508905:0",
+    "activation_time": "1541508905:263900"
+  },
+  "transport_file": {
+    "data": null,
+    "type": null
+  },
+  "transport_params": [{
+    "connection_uri": "ws://hostname/x-nmos/events/v1.0/device_id/58f6b536-ca4c-43fd-880a-9df2501fc125",
+    "ext_is_07_rest_api_url": "http://hostname/x-nmos/events/v1.0/sources/6cbd0441-7882-44cd-9557-842243a0d618",
+    "ext_is_07_source_id": "6cbd0441-7882-44cd-9557-842243a0d618"
+  }]
+}
diff --git a/examples/connectionapi-v1.1-sender-active-get-mqtt-200.json b/examples/connectionapi-v1.1-sender-active-get-mqtt-200.json
@@ -0,0 +1,15 @@
+{
+  "receiver_id": "69744dfb-0557-4202-b1f1-4d1a741ee2bb",
+  "master_enable": true,
+  "activation": {
+    "mode": "activate_immediate",
+    "requested_time": "1541508905:0",
+    "activation_time": "1541508905:0"
+  },
+  "transport_params": [{
+    "destination_host": "broker.mydomain.com",
+    "destination_port": 1883,
+    "broker_topic": "my_topic_name",
+    "ext_is_07_rest_api_url": "http://hostname/x-nmos/events/v1.0/sources/6cbd0441-7882-44cd-9557-842243a0d618",
+  }]
+}
diff --git a/examples/connectionapi-v1.1-sender-active-get-websocket-200.json b/examples/connectionapi-v1.1-sender-active-get-websocket-200.json
@@ -0,0 +1,14 @@
+{
+  "receiver_id": "69744dfb-0557-4202-b1f1-4d1a741ee2bb",
+  "master_enable": true,
+  "activation": {
+    "mode": "activate_immediate",
+    "requested_time": "1541508905:0",
+    "activation_time": "1541508905:0"
+  },
+  "transport_params": [{
+    "connection_uri": "ws://hostname/x-nmos/events/v1.0/device_id/58f6b536-ca4c-43fd-880a-9df2501fc125",
+    "ext_is_07_rest_api_url": "http://hostname/x-nmos/events/v1.0/sources/6cbd0441-7882-44cd-9557-842243a0d618",
+    "ext_is_07_source_id": "6cbd0441-7882-44cd-9557-842243a0d618"
+  }]
+}
diff --git a/examples/eventsapi-v1.0-connection-lost-message.json b/examples/eventsapi-v1.0-connection-lost-message.json
@@ -1,6 +1,7 @@
 {
-"identity":{
-	"source_id": "6cbd0441-7882-44cd-9557-842243a0d618"
-},
-"message_type": "connection_lost"
+	"identity":{
+		"source_id": "6cbd0441-7882-44cd-9557-842243a0d618",
+		"flow_id": "0febba81-d924-4bbf-b1d9-83a11fbabc61"
+	},
+	"message_type": "connection_lost"
 }
diff --git a/examples/eventsapi-v1.0-reboot-message.json b/examples/eventsapi-v1.0-reboot-message.json
@@ -1,9 +1,10 @@
 {
-"identity":{
-	"source_id": "6cbd0441-7882-44cd-9557-842243a0d618"
-},
-"timing":{
-	"creation_timestamp": "1531680501:280709600"
-},
-"message_type": "reboot"
+	"identity":{
+		"source_id": "6cbd0441-7882-44cd-9557-842243a0d618",
+		"flow_id": "0febba81-d924-4bbf-b1d9-83a11fbabc61"
+	},
+	"timing":{
+		"creation_timestamp": "1531680501:280709600"
+	},
+	"message_type": "reboot"
 }
diff --git a/examples/eventsapi-v1.0-shutdown-message.json b/examples/eventsapi-v1.0-shutdown-message.json
@@ -1,9 +1,10 @@
 {
-"identity":{
-	"source_id": "6cbd0441-7882-44cd-9557-842243a0d618"
-},
-"timing":{
-	"creation_timestamp": "1531680501:280709600"
-},
-"message_type": "shutdown"
+	"identity":{
+		"source_id": "6cbd0441-7882-44cd-9557-842243a0d618",
+		"flow_id": "0febba81-d924-4bbf-b1d9-83a11fbabc61"
+	},
+	"timing":{
+		"creation_timestamp": "1531680501:280709600"
+	},
+	"message_type": "shutdown"
 }
diff --git a/examples/eventsapi-v1.0-state-boolean-get-200.json b/examples/eventsapi-v1.0-state-boolean-get-200.json
@@ -1,13 +1,13 @@
 {
-    "identity": {
-        "source_id": "1ea39324-a32b-4e1d-86e9-33f9956ebc60"
-    },
-    "event_type": "boolean",
-    "timing": {
-        "creation_timestamp": "1532504241:104000200"
-    },
-    "payload": {
-        "value": false
-    },
-    "message_type": "state"
+  "identity": {
+    "source_id": "1ea39324-a32b-4e1d-86e9-33f9956ebc60"
+  },
+  "event_type": "boolean",
+  "timing": {
+    "creation_timestamp": "1532504241:104000200"
+  },
+  "payload": {
+    "value": false
+  },
+  "message_type": "state"
 }
diff --git a/examples/eventsapi-v1.0-state-number-get-200.json b/examples/eventsapi-v1.0-state-number-get-200.json
@@ -1,13 +1,13 @@
 {
-    "identity": {
-        "source_id": "1ea39324-a32b-4e1d-86e9-33f9956ebc60"
-    },
-    "event_type": "number",
-    "timing": {
-        "creation_timestamp": "1532504241:104000200"
-    },
-    "payload": {
-        "value": 16342
-    },
-    "message_type": "state"
+  "identity": {
+      "source_id": "1ea39324-a32b-4e1d-86e9-33f9956ebc60"
+  },
+  "event_type": "number",
+  "timing": {
+      "creation_timestamp": "1532504241:104000200"
+  },
+  "payload": {
+      "value": 16342
+  },
+  "message_type": "state"
 }
diff --git a/examples/eventsapi-v1.0-state-number-rational-get-200.json b/examples/eventsapi-v1.0-state-number-rational-get-200.json
@@ -1,14 +1,14 @@
 {
-    "identity": {
-        "source_id": "1ea39324-a32b-4e1d-86e9-33f9956ebc60"
-    },
-    "event_type": "number",
-    "timing": {
-        "creation_timestamp": "1532504241:104000200"
-    },
-    "payload": {
-        "value": 201,
-        "scale": 10
-    },
-    "message_type": "state"
+  "identity": {
+      "source_id": "1ea39324-a32b-4e1d-86e9-33f9956ebc60"
+  },
+  "event_type": "number",
+  "timing": {
+      "creation_timestamp": "1532504241:104000200"
+  },
+  "payload": {
+      "value": 201,
+      "scale": 10
+  },
+  "message_type": "state"
 }
diff --git a/examples/eventsapi-v1.0-state-string-get-200.json b/examples/eventsapi-v1.0-state-string-get-200.json
@@ -1,13 +1,13 @@
 {
-    "identity": {
-        "source_id": "1ea39324-a32b-4e1d-86e9-33f9956ebc60"
-    },
-    "event_type": "string",
-    "timing": {
-        "creation_timestamp": "1532504241:104000200"
-    },
-    "payload": {
-        "value": "ok"
-    },
-    "message_type": "state"
+  "identity": {
+    "source_id": "1ea39324-a32b-4e1d-86e9-33f9956ebc60"
+  },
+  "event_type": "string",
+  "timing": {
+    "creation_timestamp": "1532504241:104000200"
+  },
+  "payload": {
+    "value": "ok"
+  },
+  "message_type": "state"
 }

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,11 @@`
`28`	`28`	`"description": "ID of the source that holds the state that has changed",`
`29`	`29`	`"type": "string",`
`30`	`30`	`"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"`
	`31`	`+ },`
	`32`	`+ "flow_id": {`
	`33`	`+ "description": "ID of the flow carrying the message",`
	`34`	`+ "type": "string",`
	`35`	`+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"`
`31`	`36`	`}`
`32`	`37`	`}`
`33`	`38`	`},`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,11 @@`
`25`	`25`	`"description": "ID of the source which identifies the emitter of the event",`
`26`	`26`	`"type": "string",`
`27`	`27`	`"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"`
	`28`	`+ },`
	`29`	`+ "flow_id": {`
	`30`	`+ "description": "ID of the flow carrying the message",`
	`31`	`+ "type": "string",`
	`32`	`+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"`
`28`	`33`	`}`
`29`	`34`	`}`
`30`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,11 @@`
`26`	`26`	`"description": "ID of the source which identifies the emitter of the event",`
`27`	`27`	`"type": "string",`
`28`	`28`	`"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"`
	`29`	`+ },`
	`30`	`+ "flow_id": {`
	`31`	`+ "description": "ID of the flow carrying the message",`
	`32`	`+ "type": "string",`
	`33`	`+ "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"`
`29`	`34`	`}`
`30`	`35`	`}`
`31`	`36`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`		`-"identity":{`
`3`		`- "source_id": "6cbd0441-7882-44cd-9557-842243a0d618"`
`4`		`-},`
`5`		`-"message_type": "connection_lost"`
	`2`	`+ "identity":{`
	`3`	`+ "source_id": "6cbd0441-7882-44cd-9557-842243a0d618",`
	`4`	`+ "flow_id": "0febba81-d924-4bbf-b1d9-83a11fbabc61"`
	`5`	`+ },`
	`6`	`+ "message_type": "connection_lost"`
`6`	`7`	`}`