From 694c49d379669521921e371fe408d0ad08a00cbf Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Fri, 11 Oct 2024 15:39:52 +0200 Subject: [PATCH] Document schema of PusherData in push gateway API Fixes: #910 Signed-off-by: Johannes Marbach --- data/api/push-gateway/push_notifier.yaml | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/data/api/push-gateway/push_notifier.yaml b/data/api/push-gateway/push_notifier.yaml index e23d33b0..fda29da7 100644 --- a/data/api/push-gateway/push_notifier.yaml +++ b/data/api/push-gateway/push_notifier.yaml @@ -182,9 +182,15 @@ paths: type: object title: PusherData description: |- - A dictionary of additional pusher-specific data. For - 'http' pushers, this is the data dictionary passed in at - pusher creation minus the `url` key. + A dictionary of additional pusher-specific data. This + is the `data` dictionary passed in at + [pusher creation](/client-server-api/#post_matrixclientv3pushersset) + minus the `url` key. + properties: + format: + type: string + description: |- + The format to use for sending notifications. tweaks: type: object title: Tweaks