Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify that servers must forward custom keys in PusherData #1973

Merged
merged 4 commits into from
Oct 30, 2024
Merged

Clarify that servers must forward custom keys in PusherData #1973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4951bfe
Clarify that servers must forward custom keys in `PusherData`
Johennes Oct 14, 2024
ce97aa6
Add changelog
Johennes Oct 14, 2024
a6e562a
Update changelogs/client_server/newsfragments/1973.clarification
Johennes Oct 29, 2024
5aaf99a
Update data/api/client-server/pusher.yaml
Johennes Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1973.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that servers must forward custom keys in `PusherData` when sending notifications to the push gateway.
14 changes: 9 additions & 5 deletions data/api/client-server/pusher.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `format` and 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:
Expand Down