Clarify that usage of event_id_only is not mandatory

Fixes: #1026
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
pull/2255/head
Johannes Marbach 5 days ago
parent b1fd2af72c
commit fbcb6fe3a1

@ -0,0 +1 @@
Usage of `event_id_only` is not mandatory.

@ -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: |-

Loading…
Cancel
Save