add link to Confluent Wire definition

mwvgroup · Jul 6, 2024 · 4003c67 · 4003c67
1 parent 331bbea
commit 4003c67
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/pittgoogle/schema.py b/pittgoogle/schema.py
@@ -253,9 +253,13 @@ def deserialize(self, alert_bytes: bytes) -> dict:
 
 
 class _ConfluentWireAvroSchema(Schema):
-    """Schema to serialize and deserialize alert bytes in the Avro Confluent Wire Format."""
+    """Schema to serialize and deserialize alert bytes in the Avro Confluent Wire Format.
+
+    https://docs.confluent.io/platform/current/schema-registry/fundamentals/serdes-develop/index.html#wire-format
+    """
 
     def serialize(self, alert_dict: dict) -> bytes:
+        # [TODO]
         raise NotImplementedError("Confluent Wire Format not yet supported.")
 
     def deserialize(self, alert_bytes: bytes) -> dict: