Document schema of PusherData in push gateway API (#1968)

Fixes: #910 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
matrix-org · Oct 29, 2024 · 32f41f8 · 32f41f8
1 parent b1ebbb9
commit 32f41f8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/changelogs/push_gateway/newsfragments/1968.clarification b/changelogs/push_gateway/newsfragments/1968.clarification
@@ -0,0 +1 @@
+Document the schema of `PusherData`.
diff --git 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