From ce47b27acff86c5b5e7929d57c34a97973a52a93 Mon Sep 17 00:00:00 2001
From: gewitternacht <60887951+gewitternacht@users.noreply.github.com>
Date: Mon, 1 Jun 2026 14:36:37 +0200
Subject: [PATCH] disambiguate placeholder descriptions in OlmPayload example
 (#2382)

* disambiguate placeholder descriptions in OlmPayload example

* add newsfragment
---
 changelogs/client_server/newsfragments/2382.clarification | 1 +
 data/api/client-server/definitions/olm_payload.yaml       | 6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)
 create mode 100644 changelogs/client_server/newsfragments/2382.clarification

diff --git a/changelogs/client_server/newsfragments/2382.clarification b/changelogs/client_server/newsfragments/2382.clarification
new file mode 100644
index 00000000..6461d0b8
--- /dev/null
+++ b/changelogs/client_server/newsfragments/2382.clarification
@@ -0,0 +1 @@
+Disambiguate placeholder descriptions in OlmPayload example.
\ No newline at end of file
diff --git a/data/api/client-server/definitions/olm_payload.yaml b/data/api/client-server/definitions/olm_payload.yaml
index 8bac91e0..fa3e7cc9 100644
--- a/data/api/client-server/definitions/olm_payload.yaml
+++ b/data/api/client-server/definitions/olm_payload.yaml
@@ -65,15 +65,15 @@ example: {
   "sender": "<sender_user_id>",
   "recipient": "<recipient_user_id>",
   "recipient_keys": {
-    "ed25519": "<our_ed25519_key>"
+    "ed25519": "<recipient_ed25519_key>"
   },
   "keys": {
     "ed25519": "<sender_ed25519_key>"
   },
   "sender_device_keys": {
     "algorithms": ["<supported>", "<algorithms>"],
-    "user_id": "<user_id>",
-    "device_id": "<device_id>",
+    "user_id": "<sender_user_id>",
+    "device_id": "<sender_device_id>",
     "keys": {
       "ed25519:<device_id>": "<sender_ed25519_key>",
       "curve25519:<device_id>": "<sender_curve25519_key>"