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

802 commits

Author SHA1 Message Date
Matthew Hodgson 93681458d6 more tweaks 2018-05-14 22:13:28 +01:00
Matthew Hodgson cb882ba12d more tweaks 2018-05-14 22:07:49 +01:00
Matthew Hodgson 8c469e51cb lots of tweaks to the MSC verbiage 2018-05-14 22:05:28 +01:00
Ben Parsons b8f38b21a7 update introductory text 2018-05-14 14:25:12 +01:00
Ben Parsons 120fa92078 update intro 2018-05-14 10:25:10 +01:00
Ben Parsons 867307af8b new flow 2018-05-14 09:57:43 +01:00
Ben Parsons 866b0b6348 I mostly play with ascii art 2018-05-10 16:02:55 +01:00
Ben Parsons 9e37d15c8f little ascii diagram of process 2018-05-08 15:11:15 +01:00
Ben Parsons e18aa30fd2 start generating new proposals page 2018-05-02 13:47:01 +01: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
Andrew Morgan cd26c170de Specify token used in /login is not an Access Token (#1155) 
* Specify token used in /login is not an Access Token

While working through the implementation of /login in Dendrite, it was
confusing what the contents of the token attribute in the login request
body referred to. Initially, I thought it was an access token, which led
to further confusion. This commit explicitly states that the token is a
login token, which is separate from an access token, hopefully reducing
confusion for future readers.

Signed-off-by: Andrew Morgan (https://amorgan.xyz) <andrew@amorgan.xyz>
 2018-03-23 10:00:49 +00:00
Vyom Sharma 4f5ad35865 fixed minor typo 2018-03-14 20:57:38 +05:30
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
Richard van der Hoff a0dda3cae2
Merge branch 'master' into travis/m.tag 2018-03-05 18:58:53 +00: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
Maxime Dor c8393306d1 Add IS ping endpoint 2018-02-27 17:54:42 +01:00
Richard van der Hoff 3dfa643b8b Fix membership state names 
It's called 'join', not 'joined'.
 2018-02-20 20:25:31 +00:00
Michael Telatynski 4d90d2b495
fix depr link 2018-02-07 08:26:27 +00:00
Nathan Musoke 7e94cd5a0b
Typo in client-server spec: ether -> either 2018-01-20 19:15:01 +13:00
Richard van der Hoff 73118b6b29
Merge pull request #1096 from t3chguy/user_directory 
add user_directory
 2017-12-29 15:57:59 +00:00
Michael Telatynski 784adade9b
changes based on Pull Request feedback 2017-12-21 17:45:26 +00:00
Richard van der Hoff 15ca952cc3 remove spurious word 2017-12-20 10:10:02 +00:00
Richard van der Hoff 1fb7647021 send_join: clarify auth_chain description 
The auth_chain field should contain all of the auth events required to auth the
state events, as well as those required to auth the join event itself.

(cf https://github.com/matrix-org/synapse/blob/e148438/synapse/handlers/federation.py#L1076-L1077).
 2017-12-18 17:58:35 +00:00
Michael Telatynski 3d8fe6e090
merge profiles with user directory into user data, also fix typo 2017-12-18 17:01:52 +00:00
Michael Telatynski 605510e965
Merge branch 'master' into user_directory 2017-12-18 16:56:04 +00:00
Richard van der Hoff a36f8ba00d Forbid colons in MXIDs 
There is a single (AS) user on matrix.org who has a colon in their localpart,
but I suspect that is an artifact of old bridge code and won't work over
federation anyway.

Colons in MXIDs are particularly harmful because they make it impossible to
split mxids into local- and remote-parts
 2017-12-18 14:16:25 +00:00
Michael Telatynski 97445195f6
add user_directory 2017-12-17 23:42:44 +00:00
Richard van der Hoff 08d137a588 We sign the request body, not the JSON 
when signing federation requests, we put the actual request body into the
canonicaljson to be signed, not the JSON representation of it.
 2017-12-10 23:09:12 +00:00
Richard van der Hoff 56f878842c Add a warning that state resolution has problems 2017-12-10 23:05:55 +00:00
Richard van der Hoff 5ab9ee6b88 Link to auth rules 2017-11-22 22:42:55 +00:00
Richard van der Hoff 0960229a80 Document the state resolution algorithm 
or at least, my understanding of it.
 2017-11-22 22:35:47 +00:00
Maxime Dor e8af5622a7 Use proper room event type for redaction 2017-11-21 20:29:18 +01:00
Richard van der Hoff ec1a12d21b
Merge pull request #1080 from maxidor/max/ss/auth_rules 
Fix auth rules to allow first PL event
 2017-11-20 12:57:57 +00:00
Richard van der Hoff 96d93e11d7
Tweak wording of auth rules slightly 2017-11-20 12:57:34 +00:00
Florian Jacob a0455eb5b1 Threat Model: Wrong word: Banning users is a threat only if you're not authorized 
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
 2017-11-20 13:44:10 +01:00
Florian Jacob 306b3f5d62 Threat Model: Align indentation of Spying Threats. 
“Disclosure to Servers Within Chatroom” was indented lesser
than the surrounding threats.

Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
 2017-11-20 13:36:05 +01:00
Maxime Dor c4f53f58d7 Fix auth rules to allow first PL event 2017-11-18 21:25:18 +01:00
Richard van der Hoff 52dba5d89a
Merge pull request #1076 from florianjacob/fix-cas-url 
Correct CAS spec link
 2017-11-16 22:38:07 +00:00
Richard van der Hoff 58a3fa3d60
Merge pull request #1075 from matrix-org/rav/pdu_fields 
Improve documentation of Transactions and PDUs
 2017-11-16 15:42:36 +00: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
Richard van der Hoff 6a653b742c Document auth_events 2017-11-15 23:44:46 +00:00
Richard van der Hoff 632ba032af Improve Transaction and PDU documentation 
Fix a bunch of lies about the fields in these structures.
 2017-11-15 23:44:41 +00:00
Marcus Medom Ryding 8a446fa6df Modify event auth rules not to rely on depth 
Signed-off-by: Marcus Medom Ryding <mrok4a@gmail.com>
 2017-11-15 19:24:46 +01:00
Richard van der Hoff f88185ed89
Merge pull request #1073 from maxidor/max/ss/directory 
Document directory query endpoint
 2017-11-15 17:55:13 +00:00
Richard van der Hoff e9c1b87a1d Remove git log reference 
We keep the changelog up to date anyway, so there's not much point in trying to
get people to use `git log`
 2017-11-15 16:34:18 +00:00
Richard van der Hoff 0ce58fdb28 Prepare for next spec dev cycle 2017-11-15 16:23:14 +00:00
Maxime Dor bb50ec2e88 Document directory query endpoint 2017-11-15 13:40:55 +01:00
Richard van der Hoff 9b0bdb799e
Merge pull request #1054 from vberger/patch-2 
Specify namespaces for tags
 2017-11-15 07:07:45 +00:00
Maxime Dor 1045bc721d Document federation version endpoint 2017-11-15 04:16:30 +01:00
David Baker 14df31458b Attempt to clarify example a little 2017-11-14 15:39:25 +00:00
David Baker 9c5972ffe3 More formatting / grammar 2017-11-14 15:31:02 +00:00
David Baker e12c0b54ff Formatting & grammar 2017-11-14 15:12:30 +00:00
David Baker 4526ff2ea6 Double backticks in rst :/ 2017-11-14 15:11:30 +00:00
David Baker 1e4cba6b55 Don't linkify email addresses in examples 2017-11-14 15:10:11 +00:00
David Baker 3487f5d75a Spell out what we mean by a 3pid 
(and consequently rejig all the fixed-width formatting)
 2017-11-14 15:08:56 +00:00
David Baker ff85ec055e Move 3pid types down 2017-11-14 15:07:22 +00:00
David Baker 8d557ec9dc Actually this isn't necessary in this section 2017-11-14 15:05:58 +00:00
David Baker e80675c9e9 Link in markdown, not swagger 2017-11-14 15:03:51 +00:00
David Baker b789f61522 Make link more specific 2017-11-14 14:58:30 +00:00
David Baker 6edb90a08e Document threepids 
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid
is and how they work.

This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039
with some tweaks and additions.
 2017-11-14 14:36:38 +00:00
Travis Ralston b1801ea6db Spec /account/whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-12 23:49:40 -07:00
Maxime Dor 68e12feec7 Add explicit examples for JSON encoding 2017-11-05 01:14:44 +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
Michael Telatynski c2b1b7a10e
mention that we can send tokens via headers 2017-10-27 09:52:53 +01:00
Richard van der Hoff 6b23b7fc0b Merge branch 'client_server/r0.2.0_updates' 2017-10-24 23:26:56 +01:00
Richard van der Hoff b94c4a9f36 Sneaky update to 0.2.0 spec to link unstable 
This doesn't count as a spec release, right??
 2017-10-24 23:21:33 +01:00
Richard van der Hoff 6282a53ca9 Merge pull request #1032 from matrix-org/rav/mxid_grammar 
Indentifier grammar updates
 2017-10-23 10:57:47 +01:00
Richard van der Hoff 44fc033624 Fix broken links in the intro 2017-10-23 01:00:43 +01:00
Richard van der Hoff c08e6616c7 Try to make the intro link more obvious 
Fixes https://github.com/matrix-org/matrix-doc/issues/1031.
 2017-10-23 00:51:41 +01:00
Richard van der Hoff 628e723483 Move the MXID spec to the appendices 
Also link to them from the /register API doc.
 2017-10-23 00:51:40 +01:00
Richard van der Hoff 0a85fbb4f5 Allow slashes in MXIDs 
Because apparently we like slashes now.
 2017-10-23 00:22:25 +01:00
Richard van der Hoff 5fee8e54eb Document the event auth rules (#1027) 
These are a necessary precursor to state resolution.
 2017-10-20 13:36:56 +01:00
Richard van der Hoff c4bcd0a713 Merge pull request #1007 from turt2live/travis/m.room.pinned_events 
Add spec for m.room.pinned_events
 2017-10-17 17:33:27 +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 f1139b5b13 fix inter-spec link 2017-10-15 23:42:05 +01:00
Richard van der Hoff 5d473ced58 Merge pull request #1023 from matrix-org/rav/event_size 
Specify max event size more precisely
 2017-10-15 23:35:51 +01:00
Richard van der Hoff a8afbfd27d Avoid external link in search swagger 2017-10-15 23:01:54 +01:00
Richard van der Hoff bf4936d6d7 Specify max event size more precisely 
This is somewhat inelegant, and will please nobody, but I think it's more
important that we specify the current state of the onion than worry about what
would have been nice, and introduce incompatibilities while we do so.
 2017-10-15 22:18:10 +01:00
Michael Telatynski bf3b49f13c document joined_members and joined_rooms endpoints (#999) 2017-10-10 16:16:27 +01:00
Richard van der Hoff cfb547b474 Fix perspectives project link 
The perspectives project seems to be dead :/. We can at least link to the
wayback machine.
 2017-09-27 15:31:55 +01:00
Brendan Abolivier 6b6a941e36
Phrasing 2017-09-15 16:58:34 +01:00
Brendan Abolivier 8de93147b1
Typo 2017-09-15 16:57:05 +01:00
Brendan Abolivier c71575c94d
Remove useless blank line 2017-09-14 19:53:11 +01:00
Brendan Abolivier 4a99691108
Move link to the bottom of the file 2017-09-14 19:48:43 +01:00
Brendan Abolivier 9d90fa2cae
Specify third-party invites 2017-09-14 19:44:49 +01:00
Brendan Abolivier af961321e9
Specify remote invite 2017-09-14 19:15:06 +01:00
Brendan Abolivier 997e76fcf7
Update JSON body for 3PID onbind requests 2017-09-13 19:27:36 +01:00
David Baker 883767a905 Merge pull request #984 from matrix-org/rav/sync_timeout 
Make clear that the /sync timeout is zero by default
 2017-08-31 17:56:20 +01:00
Richard van der Hoff 1e3f5683c8 Make clear that the /sync timeout is zero by default 2017-08-31 16:56:50 +01:00
14mRh4X0r 6570a5c6a3 Update link to WHATWG's Living Standard FAQ entry 2017-08-11 14:22:13 +00:00
Brendan Abolivier 750d980bc0 Room member (#950) 
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
 2017-07-14 15:30:56 +01: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 0a6886e73c Fix broken link in spec 2017-04-19 16:10:31 +01:00
David Baker 6296d676c8 Remove unused ID server file 2017-03-30 13:14:57 +01:00
Richard van der Hoff da686ba4eb Specification of unpadded Base64 2017-03-01 08:50:07 +00:00
Richard van der Hoff a091d86707 Merge pull request #775 from superdump/superdump/fed-pdu-state-update-fix 
server-server api: Fix swapped pdu state update field descriptions
 2017-01-03 12:11:49 +00:00
Robert Swain db26877eee server-server api: Fix swapped pdu state update field descriptions 
Signed-off-by: Robert Swain <robert.swain@gmail.com>
 2017-01-02 23:09:56 +01:00
Robert Swain 5855bf4b16 server-server: PDUs are signed by the origin server's private key 
Not the public key.

Signed-off-by: Robert Swain <robert.swain@gmail.com>
 2017-01-02 22:46:02 +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 8a9629167a httpsify the speculator link 2016-11-27 17:28:56 +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
Richard van der Hoff aecac4f931 Merge pull request #723 from matrix-org/markjh/thumbnail_url 
Move m.* thumbnail_url to be inside info to match m.video
 2016-11-07 19:04:14 +00:00
Mark Haines 7025793ca8 Say that thumbnails should be 'mxc://' 2016-11-07 16:17:25 +00:00
Richard van der Hoff 3ee75af06f Move 'Signing JSON' to appendices 
Canonical JSON and JSON signing in general are common to the C-S spec. Move
them to the appendices instead of the S-S spec.
 2016-10-31 12:36:47 +00:00
Richard van der Hoff a5e12814ef Split appendices up 
Split appendices into multiple files
 2016-10-31 12:01:37 +00:00
Richard van der Hoff e8915215a2 Merge pull request #405 from matrix-org/dbkr/push_examples_api_path 
Fix API path in pushrules examples
 2016-10-13 22:13:24 +01:00
Richard van der Hoff 22777970da Fix speculator link 
the link to the 'latest version' was broken
 2016-10-13 17:56:53 +01: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 9265b03008 Client device doc 
Document client devices, and the mods to the login and register apis to support
them.
 2016-10-12 17:26:01 +01:00
Richard van der Hoff cbc5774ade JSON key names also use underscores. 2016-10-12 11:37:41 +01:00
Richard van der Hoff 8523af1385 Document convention of using underscores in APIs 
Everybody has agreed to it. Now we just have to remember to do it.
 2016-10-12 10:29:53 +01:00
Richard van der Hoff 7ed7944ddc Merge pull request #399 from matrix-org/dbkr/identity_api_right_path 
Use the right path for the identity API
 2016-10-10 11:32:40 +01:00
David Baker 49ee00c361 Use the right path for the identity API 2016-10-07 18:17:45 +01:00
Richard van der Hoff 6c88d698ae uia fallback example: check event origin 2016-10-07 16:26:28 +01:00
Richard van der Hoff e850fd718d window.postmessage for Interactive Auth fallback 
Require that User-Interactive auth fallback pages call
`window.postMessage` to notify apps of completion.
 2016-10-06 19:54:49 +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
Richard van der Hoff a8d35b2409 UI Auth: servers should 401 when a request fails 
(ref https://matrix.org/jira/browse/SYN-744)
 2016-10-05 11:25:49 +01:00
David Baker c16ba9488f Spec notifs API 2016-10-05 10:15:49 +01:00
Richard van der Hoff 37fb1ceb65 Merge pull request #395 from matrix-org/rav/kill_refresh_tokens 
Remove references to refresh tokens and tokenrefresh
 2016-10-04 17:55:38 +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 f4c7fdfd03 Remove references to refresh tokens and tokenrefresh 
refresh tokens are dead.
 2016-10-03 17:05:56 +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
Benjamin Saunders cade909e25 Fix inconsistencies regarding redacted_because 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-30 21:18:55 -07:00
Benjamin Saunders 77b668a5dc Fix some obsolete uses of user_id key in events 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-26 23:06:41 -07:00
Richard van der Hoff 2fa7aac3be Merge pull request #377 from Ralith/typos 
Fix typo
 2016-08-26 10:28:52 +01:00
Benjamin Saunders 80bfbbdd33 Fix typo 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-26 02:23:16 -07: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