From a2283f54999280e5f1036d0a34238b83cbd47380 Mon Sep 17 00:00:00 2001 From: Daniel Wagner-Hall Date: Tue, 8 Dec 2015 13:25:31 +0000 Subject: [PATCH 1/3] Remove /notify from client-server API --- api/{client-server => push-gateway}/push_notifier.yaml | 2 -- specification/modules/push.rst | 6 ------ 2 files changed, 8 deletions(-) rename api/{client-server => push-gateway}/push_notifier.yaml (99%) diff --git a/api/client-server/push_notifier.yaml b/api/push-gateway/push_notifier.yaml similarity index 99% rename from api/client-server/push_notifier.yaml rename to api/push-gateway/push_notifier.yaml index 271597d8..540b5686 100644 --- a/api/client-server/push_notifier.yaml +++ b/api/push-gateway/push_notifier.yaml @@ -189,5 +189,3 @@ paths: items: type: string description: A pushkey - tags: - - Push notifications diff --git a/specification/modules/push.rst b/specification/modules/push.rst index 2834688c..52f4fee3 100644 --- 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 ---------------------- From d01ff6b4956ee5f52987e76ff19fd2e8ab0720f5 Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Tue, 8 Dec 2015 16:37:51 +0000 Subject: [PATCH 2/3] Add noddy push gateway placeholder --- specification/push_gateway.rst | 42 ++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 specification/push_gateway.rst diff --git a/specification/push_gateway.rst b/specification/push_gateway.rst new file mode 100644 index 00000000..90165cde --- /dev/null +++ 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}} From bca3add9a7848f52f3ff46f0552731d753aa8d22 Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Tue, 8 Dec 2015 16:38:48 +0000 Subject: [PATCH 3/3] Formatting --- specification/push_gateway.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/push_gateway.rst b/specification/push_gateway.rst index 90165cde..3ed5ffe7 100644 --- a/specification/push_gateway.rst +++ b/specification/push_gateway.rst @@ -16,7 +16,7 @@ and the gateway submits a push notification to the push notification provider | | | | +-------------------+ | +----------------+ | | +---------------+ | | | | | | | | | | | - | Matrix homeserver+-----> Push Gateway +------> Push Provider | | + | Matrix homeserver +-----> Push Gateway +------> Push Provider | | | | | | | | | | | | +-^-----------------+ | +----------------+ | | +----+----------+ | | | | | | |