Clarify that servers must forward custom keys in PusherData

Relates to: #921 Signed-off-by: Johannes Marbach <[email protected]>
matrix-org · Oct 14, 2024 · 4951bfe · 4951bfe
1 parent ae3673d
commit 4951bfe
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/data/api/client-server/pusher.yaml b/data/api/client-server/pusher.yaml
@@ -210,17 +210,21 @@ paths:
                   type: object
                   description: |-
                     Required if `kind` is not `null`. A dictionary of information
-                    for the pusher implementation itself. If `kind` is `http`,
-                    this should contain `url` which is the URL to use to send
-                    notifications to.
+                    for the pusher implementation itself.
+
+                    If `kind` is `http`, this MUST contain `url` which is the URL
+                    to use for sending notifications. Clients MAY use this object
+                    to pass custom data to their push gateway. Servers MUST forward
+                    the entire content including any custom keys but excluding `url`
+                    when calling [`/_matrix/push/v1/notify`](/push-gateway-api/#post_matrixpushv1notify).
                   title: PusherData
                   properties:
                     url:
                       type: string
                       format: uri
                       description: |-
-                        Required if `kind` is `http`. The URL to use to send
-                        notifications to. MUST be an HTTPS URL with a path of
+                        Required if `kind` is `http`. The URL to use for sending
+                        notifications. MUST be an HTTPS URL with a path of
                         `/_matrix/push/v1/notify`.
                       example: https://push-gateway.location.here/_matrix/push/v1/notify
                     format: