Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-24 01:58:36 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
3918 commits 30 branches 42 tags 32 MiB
Commit graph

356 commits

Author SHA1 Message Date
Valentin Deniaud b2316ba782 enforce unique namespacing in new algorithms experiments 2018-08-18 11:41:45 +02:00
Valentin Deniaud eb8ea0e85a remove warning pointing at outdated doc 2018-08-18 11:41:45 +02:00
Valentin Deniaud 4e0f107ef7 document changed field behavior in e2e sync extension 2018-08-18 11:41:45 +02:00
Valentin Deniaud 248786681e fix typo 2018-08-18 11:41:45 +02:00
Valentin Deniaud e5005b2d0f document E2E events 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud 68b78dc5d8 complete Megolm documentation 2018-08-18 11:41:45 +02:00
Valentin Deniaud 669605b24a add Olm missing properties 2018-08-18 11:41:45 +02:00
Valentin Deniaud 76071bae98 explain how to verify sender_key ownership 2018-08-18 11:41:45 +02:00
Valentin Deniaud 8274f91b0b document device verification 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud a28f243ed7 document left parameter of device_lists in sync response 
fix #1171
 2018-08-18 11:41:45 +02:00
Valentin Deniaud 10c3307427 document device_one_time_keys_count in /sync/ response 
fix #1157
 2018-08-18 11:41:45 +02:00
Valentin Deniaud 2686b99080 fix json indent 2018-08-18 11:41:45 +02:00
Valentin Deniaud 07e3de3c61 add megolm messaging algorithm subsection 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud 33802dbbaf add olm messaging algorithm subsection 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
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
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 2016-09-27 14:27:27 +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 1f1dfdd91c More clarifications 2016-08-09 15:51:12 +01:00
Richard van der Hoff ec81b4c9fe More PR feedback 
Add a couple of TODO sections
 2016-08-09 12:16:20 +01:00
Richard van der Hoff 4b0e546eeb PR feedback 
Fix some typos, and clarify several aspects of server behaviour.
 2016-08-09 12:02:38 +01:00
Richard van der Hoff 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
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
Richard van der Hoff 885e6797f2 Fix double-negative in room naming 2016-07-12 14:50:49 +01:00
Richard van der Hoff 7b4c21fa77 Add link to room name bug 2016-07-12 11:47:39 +01:00
Richard van der Hoff 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
Richard van der Hoff df3f4b4ecf Fix link to draft e2e spec 2016-06-30 18:01:32 +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
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence 
Update presence spec.
 2016-06-22 14:08:44 +01:00
Richard van der Hoff 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
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
Erik Johnston 3d4d91a462 Reword to make sense 2016-03-01 16:15:59 +00:00
Erik Johnston 167a08a805 Allow idle timeout to be configurable 2016-03-01 16:13:41 +00:00
Erik Johnston bc68177471 Grammar 2016-03-01 16:07:25 +00:00
Erik Johnston f1a8306d08 Spec currently_active time and idle timeout behaviour 2016-02-23 11:25:47 +00:00
Richard van der Hoff 68a4306773 Split room previews into a separate module 
Guest access and room peeking are orthogonal
 2016-02-19 15:26:28 +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 6925547875 remove the oversimplification that the WebRTC standard is based around two-oparty communication 2016-02-11 18:34:28 +00:00
Richard van der Hoff b2e0a855cc Add 'event' to event context API 
also link through to the event schemas
 2016-02-01 17:45:45 +00:00
Richard van der Hoff cff1b4ae35 Merge pull request #251 from matrix-org/daniel/guestshiz 
Clarify guest /events and /sync
 2016-01-08 00:47:57 +00:00
Daniel Wagner-Hall 3edff684a1 Merge pull request #253 from matrix-org/daniel/guestupgrade 
Guests can upgrade to regular accounts
 2016-01-07 16:39:35 +00:00
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 2016-01-07 11:59:38 +00:00
Daniel Wagner-Hall 713415015b Remove mention that /sync takes an inline filter 2016-01-06 15:51:07 +00:00
Daniel Wagner-Hall d3f05ae49a Guests can upgrade to regular accounts 2016-01-05 17:30:55 +00:00
Daniel Wagner-Hall 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
Richard van der Hoff e4dd346a81 Restore 'client behaviour' section 
Because it's the standard
 2015-12-17 14:07:35 +00:00
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec 
Fixes https://matrix.org/jira/browse/SPEC-305
 2015-12-17 13:40:22 +00:00
Matthew Hodgson f8f76794a3 fix random whitespace bug 2015-12-14 08:40:41 +00:00
Daniel Wagner-Hall 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
Erik Johnston 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
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 2015-12-08 13:25:31 +00:00
Erik Johnston dd276d4c4d Add event context module 2015-12-07 16:56:03 +00:00
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 2015-12-07 16:28:14 +00:00
Erik Johnston 2aef684e7e Add list of required supported groupings 2015-12-07 16:02:22 +00:00
Erik Johnston c61ae86102 Specify behaviour if server does not support pagination 2015-12-07 16:00:15 +00:00
Richard van der Hoff 3939ccf20c Remove e2e drafts from master 
This is now being tracked in the main spec, on the drafts/e2e branch.
 2015-12-07 14:45:46 +00:00
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 2015-12-04 11:09:35 +00:00
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 2015-12-03 16:26:45 +00:00
Daniel Wagner-Hall 4baba85fe5 Draftify e2e in anticipation of a spec release 2015-12-03 11:52:11 +00:00
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
Matthew Hodgson b946d39886 typo 2015-12-02 01:25:07 +00:00
Daniel Wagner-Hall f6229f649a Remove confusing wording 2015-12-01 16:58:40 +00:00
Erik Johnston 23b2497743 Expand on where pagination tokens can be returned 2015-12-01 15:31:35 +00:00
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 2015-12-01 15:06:13 +00:00
Daniel Wagner-Hall 6c66bfc755 Flatten out v1 and v2_alpha directories 
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
 2015-11-30 11:22:57 +00:00
Daniel Wagner-Hall e401d3e262 Merge pull request #184 from matrix-org/daniel/splitspec 
Split spec into page-per-section
 2015-11-27 16:46:06 +00:00
Daniel Wagner-Hall e171acf01f Split spec into page-per-section 2015-11-27 16:45:47 +00:00
Mark Haines a20a49abf6 Merge pull request #168 from matrix-org/markjh/client_config 
Add API for setting client config
 2015-11-27 15:32:21 +00:00
Mark Haines c5f457cee9 Merge pull request #132 from matrix-org/markjh/room_tags 
Document a v2 api for setting tags on rooms
 2015-11-27 15:31:54 +00:00
Richard van der Hoff 0b1ba70a32 fix rst markup 
`` > `
 2015-11-27 13:33:58 +00:00
Richard van der Hoff 2dbb8ba56c Fix title levels 
make the title decoration consistent with the rest of the spec
 2015-11-27 12:53:03 +00:00
Richard van der Hoff 51ca25a472 Merge branch 'master' into markjh/end_to_end_encryption 2015-11-27 11:49:11 +00:00
Richard van der Hoff 5f4458b2ff Merge branch 'master' into markjh/end_to_end_encryption 2015-11-27 11:45:49 +00:00
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send 
PUT should always be used.
 2015-11-26 16:46:29 +00:00
Mark Haines 032ee75537 Update specification wording to match s/config/account_data/ 2015-11-19 10:42:22 +00:00
Mark Haines 05c0092664 s/config/account_data/ 2015-11-19 10:38:22 +00:00
Mark Haines 40f7eab73f s/private_user_data/account_data/ 2015-11-18 15:44:18 +00:00
Mark Haines 24c4b8b095 Merge branch 'markjh/room_tags' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	api/client-server/v1/sync.yaml
	api/client-server/v2_alpha/sync.yaml
	specification/targets.yaml
 2015-11-18 15:30:16 +00:00
Mark Haines fcbb985073 s/private_user_data/account_data/ 2015-11-18 15:27:26 +00:00
Erik Johnston 373c6c8270 Add ordering, pagination and grouping comments 2015-11-17 11:56:05 +00:00
Mark Haines c77b22778f Add some documentation on names of tags 2015-11-16 17:48:41 +00:00
Mark Haines 25769493b1 Fix template 2015-11-16 17:14:41 +00:00
Mark Haines e7fbe6f13b Limit the size of a tag 2015-11-16 17:13:02 +00:00
Mark Haines 48f35e15cb describe how to order rooms that don't have an order in their tags 2015-11-16 17:08:59 +00:00
Mark Haines 299af673da Specify how ordering of tags is supposed to work 2015-11-16 17:04:19 +00:00
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:56:35 +00:00
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config 
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
 2015-11-16 16:51:45 +00:00
Mark Haines c3769ef75c Add a module for client config to the specification 2015-11-16 16:49:32 +00:00
Daniel Wagner-Hall ea364a108b Merge pull request #161 from matrix-org/daniel/guestdisplaynames 
Merge pull request #161 from matrix-org/daniel/guestdisplaynames

Guests are allowed to set displaynames
 2015-11-12 13:23:49 +00:00
Daniel Wagner-Hall 29d9c8eec6 Guests are allowed to set displaynames 2015-11-12 12:05:02 +00:00
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 2015-11-11 17:18:58 +00:00