Merge pull request #2763 from matrix-org/travis/fix-push-tweaks

turt2live · web-flow · commit a085fabd4290 · 2020-09-04T09:15:58.000-06:00
Add a link to the push module in the push gateway spec
diff --git a/changelogs/push_gateway/newsfragments/2763.clarification 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
@@ -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}}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Clarify where to get information about the various parameter values for the notify endpoint.`