diff --git a/changelogs/client_server/newsfragments/2255.clarification b/changelogs/client_server/newsfragments/2255.clarification new file mode 100644 index 00000000..4429fccf --- /dev/null +++ b/changelogs/client_server/newsfragments/2255.clarification @@ -0,0 +1 @@ +Usage of the `event_id_only` format for push notifications is not mandatory. diff --git a/data/api/client-server/pusher.yaml b/data/api/client-server/pusher.yaml index d2a59204..0e3b7648 100644 --- a/data/api/client-server/pusher.yaml +++ b/data/api/client-server/pusher.yaml @@ -230,11 +230,14 @@ paths: format: type: string description: |- - The format to send notifications in to Push Gateways if the - `kind` is `http`. The details about what fields the - homeserver should send to the push gateway are defined in the - [Push Gateway Specification](/push-gateway-api/). Currently the only format - available is 'event_id_only'. + The format in which to send notifications to the push gateway + if the `kind` is `http`. The details about what fields the + homeserver should include are defined in the + [Push Gateway Specification](/push-gateway-api/). If omitted, + the server is expected to populate all of the event-related fields + specified in [`/_matrix/push/v1/notify`](/push-gateway-api/#post_matrixpushv1notify). + enum: + - "event_id_only" append: type: boolean description: |-