bd93481013
Reference that transaction IDs may be used to echo
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1462
2018-08-29 23:18:10 -06:00
78487a01ec
Remove references to initialSync from account data and receipts module
...
Fixes https://github.com/matrix-org/matrix-doc/issues/695
Note: This commit leaves the /join endpoints alone because they say "and /sync" rather than just initialSync
2018-08-29 23:11:00 -06:00
e227095fb4
Add rich replies
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1234
The notable parts of this are:
* The titles go to insane levels. Rich replies are fairly complex and need some splitting apart to be understandable.
* The allowed HTML tags now have an exception for `<mx-reply>`
Please note that the event example is intended to be fixed by a PR that fixes all event examples.
2018-08-29 22:58:11 -06:00
4230e375fa
Merge pull request #1465 from Zil0/key_sharing
...
Document key sharing events
2018-08-29 23:05:17 -04:00
0130620cc1
Merge pull request #1596 from uhoreg/e2e_sessions
...
specify how to handle multiple olm sessions with the same device
2018-08-29 22:45:38 -04:00
2ab2f91088
Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0
2018-08-29 17:54:34 -06:00
c03f2f8d79
Minor touchups to the room tagging API
...
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
2018-08-29 14:53:55 -06:00
2234e0b097
Mention that clients should not be producing invalid HTML
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1595
2018-08-29 12:38:15 -06:00
8e88d82a4b
fix typo in anchor. fixes #1603
2018-08-29 19:15:05 +01:00
ec20c43220
Specify the minimum CSP for media
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1066
2018-08-29 10:55:34 -06:00
39ef845a53
Merge pull request #1547 from turt2live/travis/c2s/pills
...
Document how mentions (pills) work
2018-08-29 09:13:02 -06:00
688c8ebcd3
specify how to handle multiple olm sessions with the same device
2018-08-29 10:17:20 -04:00
28ced3b0a4
fixup! document encrypted attachments
2018-08-28 15:04:40 +02:00
72c6fa2aaf
More versioned links
2018-08-27 19:33:03 -06:00
e4f8c23972
Merge pull request #1562 from turt2live/travis/c2s/html-formatting
...
Define the supported HTML subset for message events
2018-08-27 19:14:52 -06:00
fa3e9a7609
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills
2018-08-27 18:09:19 -06:00
4e885c3f77
Merge pull request #1550 from turt2live/travis/general/acls
...
Server ACLs
2018-08-27 17:48:43 -06:00
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
d7397ccd56
Provide additional rationale for kicking users when they are ACLd
2018-08-27 16:21:10 -06:00
76afef79f8
Clarify the rationale and motive for blanket IP banning and port exclusion
2018-08-27 16:14:37 -06:00
89daa3c5ce
Clarify that clients aren't required to render all the tags
...
This commit also includes minor clarifications to surrounding text.
2018-08-27 09:17:40 -06:00
5bf99aeb34
Add a note that formatted_body is not forever
2018-08-27 09:17:08 -06:00
c7822cc9a8
Link to the content repo when referencing MXC URIs in images
2018-08-27 09:16:53 -06:00
d7d28f7e5b
Remove nl as a supported HTML tag
2018-08-27 09:16:30 -06:00
aa294fac06
Define the supported HTML subset for message events
...
Also clarify that `m.notice` messages can support HTML.
Fixes https://github.com/matrix-org/matrix-doc/issues/1559
Fixes https://github.com/matrix-org/matrix-doc/issues/1560
2018-08-25 22:57:52 -06:00
312799ae78
General clarification for mention and how matrix.to URIs are meant to work
2018-08-25 22:30:49 -06:00
b7577ea237
document encrypted attachments
...
Fix #461 .
2018-08-25 17:31:49 +02:00
f6b5aee3e2
explain how to use key sharing events
2018-08-25 17:27:18 +02:00
ab0be04571
Fix titles
2018-08-22 15:24:53 -06:00
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
ef41b5c2bf
Server ACLs
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
2018-08-22 12:48:37 -06:00
9835c98544
Document how mentions (pills) work
...
Implements the proposal over at https://github.com/matrix-org/matrix-doc/issues/1067
Includes some specification for how matrix.to is structured, and how it is intended to be replaced.
2018-08-21 22:05:47 -06:00
2d8a321b46
document key sharing and m.room_key_request
2018-08-21 21:35:03 +02:00
fca1c0b7f8
Guests should support /context and /event
2018-08-20 18:06:26 +01:00
9430f2c7f9
room ID is included in Megolm plaintext, not Olm
2018-08-18 11:41:45 +02:00
8ba19b51ab
complete Olm documentation
2018-08-18 11:41:45 +02:00
b2316ba782
enforce unique namespacing in new algorithms experiments
2018-08-18 11:41:45 +02:00
eb8ea0e85a
remove warning pointing at outdated doc
2018-08-18 11:41:45 +02:00
4e0f107ef7
document changed field behavior in e2e sync extension
2018-08-18 11:41:45 +02:00
248786681e
fix typo
2018-08-18 11:41:45 +02:00
e5005b2d0f
document E2E events
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
68b78dc5d8
complete Megolm documentation
2018-08-18 11:41:45 +02:00
669605b24a
add Olm missing properties
2018-08-18 11:41:45 +02:00
76071bae98
explain how to verify sender_key ownership
2018-08-18 11:41:45 +02:00
8274f91b0b
document device verification
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
a28f243ed7
document left parameter of device_lists in sync response
...
fix #1171
2018-08-18 11:41:45 +02:00
10c3307427
document device_one_time_keys_count in /sync/ response
...
fix #1157
2018-08-18 11:41:45 +02:00
2686b99080
fix json indent
2018-08-18 11:41:45 +02:00
07e3de3c61
add megolm messaging algorithm subsection
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
33802dbbaf
add olm messaging algorithm subsection
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
e210f8b050
add e2e messaging algorithms section intro
...
This was written by Richard van der Hoff.
2018-08-18 11:41:45 +02:00
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
de961fb7d6
Improve wording on push gateways
2018-08-15 11:59:58 -06:00
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
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
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
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
2dc51d416d
Ignore stuff in `m.` you don't understand
2018-07-27 12:27:30 +01:00
f90ed4b77d
Make non-namespaced tags verboten
2018-07-27 12:08:04 +01:00
e4fd088fcc
Fix room tags spec
2018-07-27 12:05:30 +01:00
07aeaadef9
update links which used to point to docs/spec/intro
2018-07-24 11:41:03 +01:00
291a4dfc76
Third party lookup module. Fix wording
2018-07-12 16:59:30 +01:00
114bcf1a2e
Use $ref, clean up, fix errors, AS is now a C-S module.
2018-07-12 14:31:34 +01:00
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
2a6895e759
Fix typo.
2018-05-18 17:06:22 -07:00
2802fdea7e
Fix typo.
2018-04-24 19:29:00 -07:00
8d05f80cec
Sticker messages (m.sticker) ( #1158 )
2018-03-27 10:00:41 +01:00
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
d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list
2018-03-05 14:52:37 -07:00
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
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
ac861d9b97
Correct CAS spec link
...
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
2017-11-16 13:44:50 +01:00
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
5e7df0e87c
Update instant_messaging.rst
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2017-10-17 09:08:50 -06:00
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
2017-04-20 16:51:42 +01:00
5537f7a832
Allow guest access to E2E endpoints
2016-11-30 16:12:17 +00:00
4abdcc6f05
Merge pull request #402 from matrix-org/rav/device_management
...
Device management API
2016-11-09 15:09:46 +00:00
461bfdb0d8
Merge branch 'master' into rav/device_management
2016-11-09 14:34:04 +00:00
7025793ca8
Say that thumbnails should be 'mxc://'
2016-11-07 16:17:25 +00:00
41f4661d1b
Fix API path in pushrules examples
2016-10-13 15:14:29 +01:00
af515012ea
Device management API
2016-10-12 17:26:01 +01:00
42616f839c
Merge pull request #396 from matrix-org/dbkr/notifs_api
...
Spec notifs API
2016-10-06 17:21:47 +01:00
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
83b89aa1ce
dm: clarify client behaviour
2016-10-06 17:17:35 +01:00
ed2d364440
consistency
2016-10-06 11:17:43 +01:00
96b6fb0129
'In the m.room.member' event
2016-10-06 11:16:56 +01:00
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
2a987c3369
Linkify endpoints properly
2016-10-05 18:19:17 +01:00
2259a00ba2
links
2016-10-05 13:29:43 +01:00
3f66ba713c
Reference m.room.member section
2016-10-05 13:25:42 +01:00
e2024e5829
Add note on how to use the account data event
2016-10-05 13:22:30 +01:00
d791f35007
Remove unnecessary paragraph
2016-10-05 13:13:50 +01:00
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
c16ba9488f
Spec notifs API
2016-10-05 10:15:49 +01:00
8e096bdc48
Link to createRoom, not initialsync
2016-10-04 15:15:01 +01:00
85bc989c02
pr feedback
2016-10-04 15:07:14 +01:00
976d41351e
spelling
2016-10-04 12:43:41 +01:00
d39f662df5
PR feedback
2016-10-04 11:57:24 +01:00
203ea99328
Spec m.direct
2016-10-03 18:17:43 +01:00
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
ccd7bb32d5
Specification for direct-to-device messages
2016-09-27 14:27:27 +01:00
9a1db01d92
Clarify `highlight` and `sound` tweaks.
2016-09-08 11:59:49 +01:00
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
b65b0d049e
Make the display name rule an override rule
2016-08-15 18:32:35 +01:00
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
1f1dfdd91c
More clarifications
2016-08-09 15:51:12 +01:00
ec81b4c9fe
More PR feedback
...
Add a couple of TODO sections
2016-08-09 12:16:20 +01:00
4b0e546eeb
PR feedback
...
Fix some typos, and clarify several aspects of server behaviour.
2016-08-09 12:02:38 +01:00
41368dc5a7
document CAS login
...
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
2016-08-08 17:33:48 +01:00
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
885e6797f2
Fix double-negative in room naming
2016-07-12 14:50:49 +01:00
7b4c21fa77
Add link to room name bug
2016-07-12 11:47:39 +01:00
d4194dd24e
Clarify the room-naming behaviour
...
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
2016-07-11 17:49:27 +01:00
df3f4b4ecf
Fix link to draft e2e spec
2016-06-30 18:01:32 +01:00
af091ff614
Document changes to the default push rules
2016-06-22 16:34:23 +01:00
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
e80e32173f
Merge pull request #278 from matrix-org/erikj/presence
...
Update presence spec.
2016-06-22 14:08:44 +01:00
b59d16c4d1
Clarify `history_visibility` behaviour
...
Clear up some lies in the history_visibility section, and clarify behaviour for
`m.room.history_visibility` and the user's own `m.room.member` events.
2016-04-06 17:55:01 +01:00
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
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
c3c95d0c09
Fix grammar and add backticks for /sync
2016-03-08 10:17:27 +00:00
5407cc8e05
Add a snippet of documentation for a m.push_rules event.
2016-03-04 14:41:30 +00:00
3d4d91a462
Reword to make sense
2016-03-01 16:15:59 +00:00
167a08a805
Allow idle timeout to be configurable
2016-03-01 16:13:41 +00:00
bc68177471
Grammar
2016-03-01 16:07:25 +00:00
f1a8306d08
Spec currently_active time and idle timeout behaviour
2016-02-23 11:25:47 +00:00
68a4306773
Split room previews into a separate module
...
Guest access and room peeking are orthogonal
2016-02-19 15:26:28 +00:00
740f775932
Fix a couple of typos, remove .m.rule.member_event
2016-02-18 18:36:08 +00:00
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
5d85e3a505
Remove indents
2016-02-15 16:53:08 +00:00
b16af5ef64
Fix JSON, add headers
2016-02-15 16:41:47 +00:00
8a1a02a11b
Update the predefined push rules in the spec
2016-02-15 16:28:43 +00:00
6925547875
remove the oversimplification that the WebRTC standard is based around two-oparty communication
2016-02-11 18:34:28 +00:00
b2e0a855cc
Add 'event' to event context API
...
also link through to the event schemas
2016-02-01 17:45:45 +00:00
cff1b4ae35
Merge pull request #251 from matrix-org/daniel/guestshiz
...
Clarify guest /events and /sync
2016-01-08 00:47:57 +00:00
3edff684a1
Merge pull request #253 from matrix-org/daniel/guestupgrade
...
Guests can upgrade to regular accounts
2016-01-07 16:39:35 +00:00
7d9547274c
Clarify guest /events and /sync
2016-01-07 11:59:38 +00:00
713415015b
Remove mention that /sync takes an inline filter
2016-01-06 15:51:07 +00:00
d3f05ae49a
Guests can upgrade to regular accounts
2016-01-05 17:30:55 +00:00
ca67aa7b4f
Tidy up guest access spec
...
* Mention that /leave is allowed
* Mention that /sync is allowed
* Re-order such that the whole list of APIs fits on one screen
2016-01-05 13:45:04 +00:00
e4dd346a81
Restore 'client behaviour' section
...
Because it's the standard
2015-12-17 14:07:35 +00:00
b7c255a887
Tweaks/clarifications to search spec
...
Fixes https://matrix.org/jira/browse/SPEC-305
2015-12-17 13:40:22 +00:00
f8f76794a3
fix random whitespace bug
2015-12-14 08:40:41 +00:00
a484f04b33
Merge pull request #221 from matrix-org/daniel/pushaway
...
Merge pull request #221 from matrix-org/daniel/pushaway
2015-12-09 14:04:02 +00:00
c96848d1bc
Merge pull request #169 from matrix-org/erikj/search_yet_agian
...
Search: Document event context, groups and orders.
2015-12-08 16:11:03 +00:00
a2283f5499
Remove /notify from client-server API
2015-12-08 13:25:31 +00:00
dd276d4c4d
Add event context module
2015-12-07 16:56:03 +00:00
856dd9100e
Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian
2015-12-07 16:28:14 +00:00
2aef684e7e
Add list of required supported groupings
2015-12-07 16:02:22 +00:00
c61ae86102
Specify behaviour if server does not support pagination
2015-12-07 16:00:15 +00:00
Travis Ralston