Merge pull request #221 from matrix-org/daniel/pushaway

9 years ago · a484f04b33
parent a33e49fd1e bca3add9a7
commit a484f04b33
3 changed files with 42 additions and 8 deletions
--- a/api/client-server/push_notifier.yaml
+++ b/api/client-server/push_notifier.yaml
@ -189,5 +189,3 @@ paths:
                items:
                  type: string
                  description: A pushkey
-      tags:
-        - Push notifications
--- a/specification/modules/push.rst
+++ b/specification/modules/push.rst
@ -404,12 +404,6 @@ sender and content rules)::
 Server behaviour
 ----------------

-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
-homeserver SHOULD retry for a reasonable amount of time using exponential-backoff.
-
-{{push_notifier_http_api}}
-
 Push Gateway behaviour
 ----------------------

--- a/specification/push_gateway.rst
+++ b/specification/push_gateway.rst
@ -0,0 +1,42 @@
+Push Gateway API
+================
+
+Clients may want to receive push notifications when events are received at
+the homeserver. This is managed by a distinct entity called the Push Gateway.
+A client's homeserver forwards information about the event to the push gateway
+and the gateway submits a push notification to the push notification provider
+(e.g. APNS, GCM).
+
+
+::
+
+                                   +--------------------+  +-------------------+
+                  Matrix HTTP      |                    |  |                   |
+             Notification Protocol |   App Developer    |  |   Device Vendor   |
+                                   |                    |  |                   |
+           +-------------------+   | +----------------+ |  | +---------------+ |
+           |                   |   | |                | |  | |               | |
+           | Matrix homeserver +----->  Push Gateway  +------> Push Provider | |
+           |                   |   | |                | |  | |               | |
+           +-^-----------------+   | +----------------+ |  | +----+----------+ |
+             |                     |                    |  |      |            |
+    Matrix   |                     |                    |  |      |            |
+ Client/Server API  +              |                    |  |      |            |
+             |      |              +--------------------+  +-------------------+
+             |   +--+-+                                           |             
+             |   |    <-------------------------------------------+             
+             +---+    |                                                        
+                 |    |          Provider Push Protocol                        
+                 +----+                                                        
+                                                                               
+         Mobile Device or Client                                               
+
+
+Homeserver behaviour
+--------------------
+
+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
+homeserver SHOULD retry for a reasonable amount of time using exponential backoff.
+
+{{push_notifier_http_api}}