docs: update schemas to match upstream

andyholmes · Apr 16, 2024 · 37203b4 · 37203b4
1 parent bd0c7e8
commit 37203b4
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 8 deletions.
diff --git a/doc/schemas/kdeconnect.telephony.json b/doc/schemas/kdeconnect.telephony.json
@@ -1,15 +1,14 @@
 {
     "$schema": "http://json-schema.org/schema#",
     "title": "kdeconnect.telephony",
-    "description": "This packet is a telephony event, such as the phone ringing.",
+    "description": "This packet is a telephony event, such as the phone ringing.\n\nNote that both the `sms` event type and the `messageBody` field are deprecated in favor of the SMS plugin.",
     "examples": [
         {
             "id": 0,
             "type": "kdeconnect.telephony",
             "body": {
                 "event": "talking",
                 "contactName": "John Smith",
-                "messageBody": "A text message",
                 "phoneNumber": "555-555-5555",
                 "phoneThumbnail": "<base64 encoded JPEG>"
             }
@@ -23,6 +22,17 @@
                 "phoneNumber": "555-555-5555",
                 "isCancel": true
             }
+        },
+        {
+            "id": 0,
+            "type": "kdeconnect.telephony",
+            "body": {
+                "event": "sms",
+                "contactName": "John Smith",
+                "messageBody": "A text message",
+                "phoneNumber": "555-555-5555",
+                "phoneThumbnail": "<base64 encoded JPEG>"
+            }
         }
     ],
     "type": "object",
@@ -42,8 +52,7 @@
         "body": {
             "type": "object",
             "required": [
-                "event",
-                "phoneNumber"
+                "event"
             ],
             "properties": {
                 "event": {
@@ -56,15 +65,15 @@
                     ]
                 },
                 "contactName": {
-                    "type": ["string", "null"],
+                    "type": "string",
                     "description": "The contact name associated with the event."
                 },
                 "messageBody": {
                     "type": "string",
-                    "description": "The message text associated with the event."
+                    "description": "⚠️ Deprecated: The message text associated with the event."
                 },
                 "phoneNumber": {
-                    "type": ["string", "null"],
+                    "type": "string",
                     "description": "The phone number associated with the event."
                 },
                 "phoneThumbnail": {
@@ -79,3 +88,4 @@
         }
     }
 }
+
diff --git a/doc/sdk/protocol.py b/doc/sdk/protocol.py
@@ -63,7 +63,8 @@
 
 {MD_HEADER * 4} `Null`
 
-The intentional absence of any object value.
+The intentional absence of any object value. Note that this type is currently
+unused in the protocol and reserved for future use.
 
 {MD_HEADER * 3} Symbols