#8 - refine protocol-level handling, drop MQTT 3.x support

Signed-off-by: Lance-Drane <Lance-Drane@users.noreply.github.com>

Author: Lance-Drane

README.md

@@ -19,7 +19,8 @@ For a high-level overview, please see [the architecture website.](https://inters
 
 - Event-driven architecture
 - Support core interaction types: request/response, events, commands, statuses
-- Borrows several concepts from [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest), and intends to support multiple different protocols. Currently, we support MQTT 3.1.1 and AMQP 0.9.1, but other protocols will be supported as well.
+- Borrows several concepts from [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest), and intends to support multiple different protocols. Currently, we support MQTT 5.0 and AMQP 0.9.1, but other protocols will be supported as well.
+  - As a general rule, we will not support any protocols which do not support headers, do not allow for asynchronous messaging, or require the microservice itself to "keep alive" multiple connections.
 - Users automatically generate schema from code; schemas are part of the core contract of an INTERSECT microservice, and both external inputs and microservice outputs are required to uphold this contract.
 
 ## Authors

examples/1_hello_world/hello_client.py

@@ -48,7 +48,7 @@ def simple_client_callback(
                 'username': 'intersect_username',
                 'password': 'intersect_password',
                 'port': 1883,
-                'protocol': 'mqtt3.1.1',
+                'protocol': 'mqtt5.0',
             },
         ],
     }

examples/1_hello_world/hello_service.py

@@ -21,7 +21,7 @@ class HelloServiceCapabilityImplementation(IntersectBaseCapabilityImplementation
     but we do not use it here.
 
     The operation we are calling is `say_hello_to_name` , so the message being sent will need to have
-    an operationId of `say_hello_to_name`. The operation expects a string sent to it in the payload,
+    an operation_id of `say_hello_to_name`. The operation expects a string sent to it in the payload,
     and will send a string back in its own payload.
     """
 
@@ -50,7 +50,7 @@ def say_hello_to_name(self, name: str) -> str:
                 'username': 'intersect_username',
                 'password': 'intersect_password',
                 'port': 1883,
-                'protocol': 'mqtt3.1.1',
+                'protocol': 'mqtt5.0',
             },
         ],
     }

examples/1_hello_world/hello_service_schema.json

@@ -54,7 +54,7 @@
         "type": "string",
         "title": "Status"
       },
-      "description": "Rudimentary capability implementation example.\n\nAll capability implementations are required to have an @intersect_status decorated function,\nbut we do not use it here.\n\nThe operation we are calling is `say_hello_to_name` , so the message being sent will need to have\nan operationId of `say_hello_to_name`. The operation expects a string sent to it in the payload,\nand will send a string back in its own payload."
+      "description": "Rudimentary capability implementation example.\n\nAll capability implementations are required to have an @intersect_status decorated function,\nbut we do not use it here.\n\nThe operation we are calling is `say_hello_to_name` , so the message being sent will need to have\nan operation_id of `say_hello_to_name`. The operation expects a string sent to it in the payload,\nand will send a string back in its own payload."
     }
   },
   "components": {

examples/1_hello_world_amqp/hello_service.py

@@ -22,7 +22,7 @@ class HelloServiceCapabilityImplementation(IntersectBaseCapabilityImplementation
     but we do not use it here.
 
     The operation we are calling is `say_hello_to_name` , so the message being sent will need to have
-    an operationId of `say_hello_to_name`. The operation expects a string sent to it in the payload,
+    an operation_id of `say_hello_to_name`. The operation expects a string sent to it in the payload,
     and will send a string back in its own payload.
     """
 

examples/1_hello_world_amqp/hello_service_schema.json

@@ -54,7 +54,7 @@
         "type": "string",
         "title": "Status"
       },
-      "description": "Rudimentary capability implementation example.\n\nAll capability implementations are required to have an @intersect_status decorated function,\nbut we do not use it here.\n\nThe operation we are calling is `say_hello_to_name` , so the message being sent will need to have\nan operationId of `say_hello_to_name`. The operation expects a string sent to it in the payload,\nand will send a string back in its own payload."
+      "description": "Rudimentary capability implementation example.\n\nAll capability implementations are required to have an @intersect_status decorated function,\nbut we do not use it here.\n\nThe operation we are calling is `say_hello_to_name` , so the message being sent will need to have\nan operation_id of `say_hello_to_name`. The operation expects a string sent to it in the payload,\nand will send a string back in its own payload."
     }
   },
   "components": {

examples/1_hello_world_events/hello_client.py

@@ -68,7 +68,7 @@ def simple_event_callback(
                 'username': 'intersect_username',
                 'password': 'intersect_password',
                 'port': 1883,
-                'protocol': 'mqtt3.1.1',
+                'protocol': 'mqtt5.0',
             },
         ],
     }

examples/1_hello_world_events/hello_service.py

@@ -23,7 +23,7 @@ class HelloServiceCapabilityImplementation(IntersectBaseCapabilityImplementation
     but we do not use it here.
 
     The operation we are calling is `say_hello_to_name` , so the message being sent will need to have
-    an operationId of `say_hello_to_name`. The operation expects a string sent to it in the payload,
+    an operation_id of `say_hello_to_name`. The operation expects a string sent to it in the payload,
     and will send a string back in its own payload.
 
     The operation we are calling also emits its own event.
@@ -58,7 +58,7 @@ def say_hello_to_name(self, name: str) -> str:
                 'username': 'intersect_username',
                 'password': 'intersect_password',
                 'port': 1883,
-                'protocol': 'mqtt3.1.1',
+                'protocol': 'mqtt5.0',
             },
         ],
     }

examples/1_hello_world_events/hello_service_schema.json

@@ -59,7 +59,7 @@
         "type": "string",
         "title": "Status"
       },
-      "description": "Rudimentary capability implementation example.\n\nAll capability implementations are required to have an @intersect_status decorated function,\nbut we do not use it here.\n\nThe operation we are calling is `say_hello_to_name` , so the message being sent will need to have\nan operationId of `say_hello_to_name`. The operation expects a string sent to it in the payload,\nand will send a string back in its own payload.\n\nThe operation we are calling also emits its own event."
+      "description": "Rudimentary capability implementation example.\n\nAll capability implementations are required to have an @intersect_status decorated function,\nbut we do not use it here.\n\nThe operation we are calling is `say_hello_to_name` , so the message being sent will need to have\nan operation_id of `say_hello_to_name`. The operation expects a string sent to it in the payload,\nand will send a string back in its own payload.\n\nThe operation we are calling also emits its own event."
     }
   },
   "components": {

examples/1_hello_world_minio/hello_client.py

@@ -1,7 +1,7 @@
 import logging
 
 from intersect_sdk import (
-    INTERSECT_JSON_VALUE,
+    INTERSECT_RESPONSE_VALUE,
     IntersectClient,
     IntersectClientCallback,
     IntersectClientConfig,
@@ -14,7 +14,7 @@
 
 
 def simple_client_callback(
-    _source: str, _operation: str, _has_error: bool, payload: INTERSECT_JSON_VALUE
+    _source: str, _operation: str, _has_error: bool, payload: INTERSECT_RESPONSE_VALUE
 ) -> None:
     """This simply prints the response from the service to your console.
 
@@ -59,7 +59,7 @@ def simple_client_callback(
                 'username': 'intersect_username',
                 'password': 'intersect_password',
                 'port': 1883,
-                'protocol': 'mqtt3.1.1',
+                'protocol': 'mqtt5.0',
             },
         ],
     }