Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-28 00:43:42 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Improve wording on push gateways

Browse source
This commit is contained in:
Travis Ralston 2018-08-15 11:59:58 -06:00
parent 6ad71f785e
commit de961fb7d6
4 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
api/client-server/pusher.yaml
View file

@ -226,12 +226,11 @@ paths:
format: format:
type: string type: string
description: |- description: |-
The format to send notifications in to Push Gateways. If The format to send notifications in to Push Gateways if the
unset or unrecognized, the homeserver should populate as ``kind`` is ``http``. The details about what fields the
many fields as it can in the push notification. If set to homeserver should send to the push gateway are defined in the
``"event_id_only"``, the homeserver should only send the `Push Gateway Specification`_. Currently the only format
absolute minimum amount of information possible to the push available is 'event_id_only'.
gateway by not including optional fields.
append: append:
type: boolean type: boolean
description: |- description: |-

6
api/push-gateway/push_notifier.yaml
View file

@ -145,9 +145,9 @@ paths:
type: object type: object
title: EventContent title: EventContent
description: |- description: |-
The ``content`` field from the event, if present. If the The ``content`` field from the event, if present. The pusher
event had no content field or the pusher wishes to not include may omit this if the event had no content or for any other
it, this field is omitted. reason.
counts: counts:
type: object type: object
title: Counts title: Counts

5
specification/modules/push.rst
View file

@ -65,9 +65,6 @@ APNS or Google's GCM. This happens as follows:
notifications. notifications.
5. The Push Provider sends the notification to the device. 5. The Push Provider sends the notification to the device.
Homeservers may optionally support email notifications or other push kinds
of push, identified by the ``kind`` field of the pusher configuration.
Definitions for terms used in this section are below: Definitions for terms used in this section are below:
Push Provider Push Provider
@ -625,3 +622,5 @@ shouldn't be sent in the push itself where possible. Instead, Push Gateways
should send a "sync" command to instruct the client to get new events from the should send a "sync" command to instruct the client to get new events from the
homeserver directly. homeserver directly.
.. _`Push Gateway Specification`: ../push_gateway/unstable.html

5
specification/push_gateway.rst
View file

@ -67,4 +67,9 @@ This describes the format used by "HTTP" pushers to send notifications of
events to Push Gateways. If the endpoint returns an HTTP error code, the events to Push Gateways. If the endpoint returns an HTTP error code, the
homeserver SHOULD retry for a reasonable amount of time using exponential backoff. homeserver SHOULD retry for a reasonable amount of time using exponential backoff.
When pushing notifications for events, the hoemserver is expected to include all of
the event-related fields in the ``/notify`` request. When the homeserver is performing
a push where the ``format`` is ``"event_id_only"``, only the ``event_id``, ``room_id``,
``counts``, and ``devices`` are required to be populated.
{{push_notifier_push_http_api}} {{push_notifier_push_http_api}}