Change id in the push gateway poke to be event_id and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec.

This commit is contained in:
David Baker 2016-04-06 18:28:21 +01:00
parent 12943134bd
commit 71cb646541
5 changed files with 36 additions and 11 deletions

View file

@ -20,6 +20,7 @@ The following APIs are documented in this specification:
- `Server-Server API <server_server.html>`_ version %SERVER_RELEASE_LABEL% for writing servers which can federate with Matrix.
- `Application Service API <application_service.html>`_ version %CLIENT_RELEASE_LABEL% for writing privileged plugins to servers.
- `Identity Service API <identity_service.html>`_ version unstable for mapping third party identifiers (e.g. email addresses) to Matrix IDs.
- `Push Gateway API <push_gateway.html>`_ version unstable for implementing a server that receives notifications about Matrix events a user is interested in.
There are also some `appendices <appendices.html>`_.

View file

@ -39,4 +39,4 @@ 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_notifier_push_http_api}}

View file

@ -22,6 +22,9 @@ targets:
identity_service:
files:
- identity_service_api.rst
push_gateway:
files:
- push_gateway.rst
appendices:
files:
- appendices.rst