Commit graph

392 commits

Author SHA1 Message Date
Valentin Deniaud
e210f8b050 add e2e messaging algorithms section intro
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
Travis Ralston
4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid
Document OpenID in the client-server and server-server APIs
2018-08-17 08:57:33 -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
Travis Ralston
88b35d1be5 Clarify how third party invites work
This adds several diagrams to the Client-Server API about how invites
are handled, including what the server is expected to do. This helps
implementors know what they are supposed to do in the common cases,
and infer where needed to get the more complex cases correct.

Although lacking in some areas, this is how third party invites work
today.

A link to the now-improved client-server documentation for third party
invites has been added to the server-server specification. The existing
server-server specification needed no further changes on the subject.

Fixes https://github.com/matrix-org/matrix-doc/issues/1366
2018-08-13 16:29:50 -06:00
Travis Ralston
8ffac01efe Document OpenID in the client-server API
Part of https://github.com/matrix-org/matrix-doc/issues/857

Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
2018-08-07 22:10:11 -06:00
David Baker
803ef536ba Fix grammar in room tag spec
Have removed the second clause about how the client interprets them:
I was trying to think how to rephrase it but I think in reality it's
probably just redundant.
2018-08-06 15:58:30 +01:00
David Baker
2dc51d416d Ignore stuff in m. you don't understand 2018-07-27 12:27:30 +01:00
David Baker
f90ed4b77d Make non-namespaced tags verboten 2018-07-27 12:08:04 +01:00
David Baker
e4fd088fcc Fix room tags spec 2018-07-27 12:05:30 +01:00
Ben Parsons
07aeaadef9 update links which used to point to docs/spec/intro 2018-07-24 11:41:03 +01:00
Andrew Morgan
291a4dfc76 Third party lookup module. Fix wording 2018-07-12 16:59:30 +01:00
Andrew Morgan
114bcf1a2e Use $ref, clean up, fix errors, AS is now a C-S module. 2018-07-12 14:31:34 +01:00
Travis Ralston
9037f506ac Document how to report content
Fixes: https://github.com/matrix-org/matrix-doc/issues/739

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-05-27 12:19:30 -06:00
Jason Volk
2a6895e759 Fix typo. 2018-05-18 17:06:22 -07:00
Jason Volk
2802fdea7e Fix typo. 2018-04-24 19:29:00 -07:00
Richard Lewis
8d05f80cec Sticker messages (m.sticker) (#1158) 2018-03-27 10:00:41 +01:00
Travis Ralston
331e49bd0d Improve the documentation of ignored users
* Fix the event schema to represent the real world
* Add the module to the spec targets
* Remove incomplete thought from the client behaviour
* Link to the account data API
* Minor word choice changes

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 09:00:32 -07:00
Travis Ralston
d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list 2018-03-05 14:52:37 -07:00
Travis Ralston
e862ef60ae Spec ignoring users
Adds https://github.com/matrix-org/matrix-doc/issues/528

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-03 15:39:10 -07:00
Travis Ralston
a3f006353c Tag ordering is defined as a number between 0 and 1, not strings
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-03 12:40:48 -07:00
Florian Jacob
ac861d9b97 Correct CAS spec link
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
2017-11-16 13:44:50 +01:00
Victor Berger
cc8128edad
Specify namespaces for tags
This is a proposition for closing #931.

This should be a fairly uncontroversial addition (apart from bike-shedding), which only defines behavior for clients that want use tags or expose tagging functionality to their users.

The idea of adding this to the spec is to ensure clients can peacefully share the tag namespace without conflicting with each other, using rules similar to namespaces for state keys.
2017-11-03 17:03:37 +01:00
Travis Ralston
5e7df0e87c Update instant_messaging.rst
Signed-off-by: Travis Ralston <travpc@gmail.com>
2017-10-17 09:08:50 -06:00
Richard van der Hoff
da6938b818 Key management APIs (#894)
Spec the e2e key-management APIs.
2017-04-20 16:51:42 +01:00
Richard van der Hoff
5537f7a832 Allow guest access to E2E endpoints 2016-11-30 16:12:17 +00:00
Richard van der Hoff
4abdcc6f05 Merge pull request #402 from matrix-org/rav/device_management
Device management API
2016-11-09 15:09:46 +00:00
Richard van der Hoff
461bfdb0d8 Merge branch 'master' into rav/device_management 2016-11-09 14:34:04 +00:00
Mark Haines
7025793ca8 Say that thumbnails should be 'mxc://' 2016-11-07 16:17:25 +00:00
David Baker
41f4661d1b Fix API path in pushrules examples 2016-10-13 15:14:29 +01:00
Richard van der Hoff
af515012ea Device management API 2016-10-12 17:26:01 +01:00
Richard van der Hoff
42616f839c Merge pull request #396 from matrix-org/dbkr/notifs_api
Spec notifs API
2016-10-06 17:21:47 +01:00
Richard van der Hoff
909aef2b18 Merge pull request #389 from matrix-org/erikj/create_room_is_direct
Spec /createRoom is_direct flag, is_direct in member event and m.direct
2016-10-06 17:19:48 +01:00
Richard van der Hoff
83b89aa1ce dm: clarify client behaviour 2016-10-06 17:17:35 +01:00
David Baker
ed2d364440 consistency 2016-10-06 11:17:43 +01:00
David Baker
96b6fb0129 'In the m.room.member' event 2016-10-06 11:16:56 +01:00
David Baker
301595c071 Linkify account_data API
Also change other links because it turns out the .. isn't part
of the syntax
2016-10-06 11:15:44 +01:00
David Baker
2a987c3369 Linkify endpoints properly 2016-10-05 18:19:17 +01:00
David Baker
2259a00ba2 links 2016-10-05 13:29:43 +01:00
David Baker
3f66ba713c Reference m.room.member section 2016-10-05 13:25:42 +01:00
David Baker
e2024e5829 Add note on how to use the account data event 2016-10-05 13:22:30 +01:00
David Baker
d791f35007 Remove unnecessary paragraph 2016-10-05 13:13:50 +01:00
David Baker
4480553bf9 Move m.direct description to the swagger
Also change the swagger to yaml so I can put that description in it
without having to figure out how to embed that in json.
2016-10-05 13:12:14 +01:00
David Baker
c16ba9488f Spec notifs API 2016-10-05 10:15:49 +01:00
David Baker
8e096bdc48 Link to createRoom, not initialsync 2016-10-04 15:15:01 +01:00
David Baker
85bc989c02 pr feedback 2016-10-04 15:07:14 +01:00
David Baker
976d41351e spelling 2016-10-04 12:43:41 +01:00
David Baker
d39f662df5 PR feedback 2016-10-04 11:57:24 +01:00
David Baker
203ea99328 Spec m.direct 2016-10-03 18:17:43 +01:00
Richard van der Hoff
ebaaa7e3b3 Review feedback
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
2016-09-29 13:18:45 +01:00