From 287745955375625dcffac59de656b7e220d1920c Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Wed, 2 Sep 2020 14:04:55 -0600 Subject: [PATCH] Add a link to the push module in the push gateway spec --- changelogs/push_gateway/newsfragments/2763.clarification | 1 + specification/push_gateway.rst | 3 +++ 2 files changed, 4 insertions(+) create mode 100644 changelogs/push_gateway/newsfragments/2763.clarification diff --git a/changelogs/push_gateway/newsfragments/2763.clarification b/changelogs/push_gateway/newsfragments/2763.clarification new file mode 100644 index 00000000..d6886641 --- /dev/null +++ b/changelogs/push_gateway/newsfragments/2763.clarification @@ -0,0 +1 @@ +Clarify where to get information about the various parameter values for the notify endpoint. diff --git a/specification/push_gateway.rst b/specification/push_gateway.rst index cba38b6c..46c0000d 100644 --- a/specification/push_gateway.rst +++ b/specification/push_gateway.rst @@ -89,4 +89,7 @@ the event-related fields in the ``/notify`` request. When the homeserver is perf a push where the ``format`` is ``"event_id_only"``, only the ``event_id``, ``room_id``, ``counts``, and ``devices`` are required to be populated. +Note that most of the values and behaviour of this endpoint is described by the Client-Server +API's `Push Module <../client_server/%CLIENT_RELEASE_LABEL%.html#module-push>`_. + {{push_notifier_push_http_api}}