Travis Ralston
2ab2f91088
Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0
2018-08-29 17:54:34 -06:00
Travis Ralston
72c6fa2aaf
More versioned links
2018-08-27 19:33:03 -06:00
Travis Ralston
bac0392a2d
General clarity for push rule defaults and where to get information
...
Include moving a roaming condition that was under the wrong rule.
2018-08-27 17:28:08 -06:00
Travis Ralston
ab0be04571
Fix titles
2018-08-22 15:24:53 -06:00
Travis Ralston
7ec3cc4343
General improvements to the push rules module
...
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.
Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
2018-08-22 15:21:21 -06:00
Travis Ralston
de961fb7d6
Improve wording on push gateways
2018-08-15 11:59:58 -06:00
Travis Ralston
6ad71f785e
Improve documentation for pushers and push gateways
...
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format
Note: this does not attempt to document push rules, just pushers.
Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
2018-08-14 12:51:50 -06:00
David Baker
41f4661d1b
Fix API path in pushrules examples
2016-10-13 15:14:29 +01:00
David Baker
c16ba9488f
Spec notifs API
2016-10-05 10:15:49 +01:00
David Baker
9a1db01d92
Clarify `highlight` and `sound` tweaks.
2016-09-08 11:59:49 +01:00
David Baker
fd888fcbda
Merge pull request #373 from matrix-org/dbkr/contains_display_name_override
...
Make the display name rule an override rule
2016-08-17 09:43:44 +01:00
David Baker
b65b0d049e
Make the display name rule an override rule
2016-08-15 18:32:35 +01:00
David Baker
6592646ee9
Add dot prefix to .rule.master
...
It's a default rule, so it needs a dot
2016-08-15 18:29:39 +01:00
Richard van der Hoff
49cd65dd58
Add a license to the spec
...
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
2016-07-12 17:28:30 +01:00
Mark Haines
af091ff614
Document changes to the default push rules
2016-06-22 16:34:23 +01:00
Mark Haines
30a3302921
Merge pull request #274 from matrix-org/markjh/default_rules
...
Update the predefined push rules in the spec
2016-06-22 16:14:21 +01:00
Kegsay
506accee27
Merge pull request #288 from matrix-org/markjh/pushrule_stream
...
Add a snippet of documentation for a m.push_rules event.
2016-03-10 14:05:42 +00:00
Daniel Wagner-Hall
f4f186baee
Add _cs suffix to client-server http APIs
...
I'm about to add identity service APIs, so differentiating is good.
2016-03-08 17:42:41 +00:00
Mark Haines
c3c95d0c09
Fix grammar and add backticks for /sync
2016-03-08 10:17:27 +00:00
Mark Haines
5407cc8e05
Add a snippet of documentation for a m.push_rules event.
2016-03-04 14:41:30 +00:00
Mark Haines
740f775932
Fix a couple of typos, remove .m.rule.member_event
2016-02-18 18:36:08 +00:00
Mark Haines
3db6980e0b
Remove references to device specific push rules
...
Since they weren't implemented on the servers and weren't
used by the clients.
2016-02-18 16:05:47 +00:00
Mark Haines
5d85e3a505
Remove indents
2016-02-15 16:53:08 +00:00
Mark Haines
b16af5ef64
Fix JSON, add headers
2016-02-15 16:41:47 +00:00
Mark Haines
8a1a02a11b
Update the predefined push rules in the spec
2016-02-15 16:28:43 +00:00
Matthew Hodgson
f8f76794a3
fix random whitespace bug
2015-12-14 08:40:41 +00:00
Daniel Wagner-Hall
a2283f5499
Remove /notify from client-server API
2015-12-08 13:25:31 +00:00
Daniel Wagner-Hall
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall
2f3a00fe34
Consistently spell homeserver as homeserver
2015-12-02 19:23:33 +00:00
Mark Haines
e3e8026025
Fix list formatting so that we aren't including everything in blockquotes
2015-10-23 10:51:31 +01:00
Kegan Dougal
3608f3a282
SPEC-144 : Use https examples not http.
2015-10-14 14:44:09 +01:00
Kegan Dougal
8f5c796884
Linkify 'pushers'
2015-10-12 17:50:46 +01:00
Kegan Dougal
f2a6950cc3
Minor tweaks; allow objects without props/parents if a title is set
...
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
2015-10-08 16:21:26 +01:00
Kegan Dougal
9c95ee5c1f
Modify wording and formatting
2015-10-08 15:36:03 +01:00
Kegan Dougal
31ae4b3859
Swaggerify push notification API
...
Edit units.py to support nested JSON request keys
2015-10-08 13:08:21 +01:00
Kegan Dougal
a9618a981b
Swaggerify the /enabled endpoint
2015-10-08 11:16:42 +01:00
Kegan Dougal
56ce432399
Get profile tag keys displaying correctly.
2015-10-08 10:14:05 +01:00
Kegan Dougal
db25276856
Start adding in push definitions
...
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
2015-10-07 17:44:05 +01:00
Kegan Dougal
c5edc60c4c
Add push YAML for pushers endpoint.
...
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
2015-10-07 16:01:36 +01:00
Kegan Dougal
d3ed517ebf
Finish laying out rough sections
2015-10-07 14:14:15 +01:00
Kegan Dougal
a7400508c6
Define module titles from the template
2015-10-07 14:07:36 +01:00
Kegan Dougal
319ba8f404
Combine push files into one
...
We can fork it out again if it makes sense, but certainly 2/3 of the files
were very small and it just adds more complexity when refactoring.
2015-10-07 14:00:16 +01:00