wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
5313 commits 4 branches 0 tags 17 MiB
Commit graph

233 commits

Author SHA1 Message Date
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
Richard van der Hoff
c51c4acf7f Clarifications to authentication mechanisms 
* Make the purpose of the `auth` key in /register requests explicit, and say
  that it should be empty at first.

* Restructure the UA-auth section a bit.

* In the UA-auth section, say that clients should submit no `auth` to start
  with, and add 'Stage 0' representing  this to the example.

* s/{stage,login} type/authentication type/ in the UA-auth section. Seems
   clearer to me.

* Try to distinguish the example responses from the example requests by giving
  an HTTP header.
 2016-08-15 10:28:15 +01:00
Richard van der Hoff
0248afe6ac login with invalid token gives a 403 2016-08-09 16:28:29 +01:00
Richard van der Hoff
1f1dfdd91c More clarifications 2016-08-09 15:51:12 +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
ec20f15407 /tokenrefresh should expire the access token 
It's possible for clients to call /tokenrefresh before the access_token has
expired, potentially leading to a proliferation of valid access_tokens.
 2016-07-19 09:17:14 +01:00
Richard van der Hoff
2370a4c970 Spell out the state algorithm for createRoom 
Fixes https://matrix.org/jira/browse/SPEC-429.

Synapse currently follows the specified ordering, but does *not* give the
specified error when the state is invalid (instead it creates the room anyway
but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real
problem for any real clients, and nothing would break if we changed this in
synapse, so it might as well go in the spec anyway.
 2016-07-18 13:01:45 +01:00
Richard van der Hoff
a64f9bbb63 C-S spec: Fix 'unstable' in link to /context API 2016-07-14 16:23:59 +01:00
Richard van der Hoff
b5f9e896ba C-S spec: Fix 'unstable' in link to /context API 2016-07-14 16:20:59 +01:00
Richard van der Hoff
a2ab6854ff CS spec: Add r0.2.0 to historical version list 2016-07-14 15:40:49 +01:00
Richard van der Hoff
8ac45d7948 Merge pull request #353 from matrix-org/rav/room_membership 
Clarify the room-membership APIs
 2016-07-13 11:34:14 +01:00
Richard van der Hoff
0c06ea0e67 Merge pull request #356 from matrix-org/rav/fix_redaction 
Fix name of prev_content to preserve on redactions
 2016-07-13 11:14:07 +01:00
Richard van der Hoff
a9d3cfd13c Merge branch 'master' into rav/link_undeprecated_endpoints 2016-07-13 11:09:53 +01:00
Richard van der Hoff
d92515bce3 Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync 
Move /room/x/initialSync to after the undeprecated APIs
 2016-07-13 11:07:11 +01:00
Richard van der Hoff
d8a47dbb5d Merge pull request #352 from matrix-org/rav/kill_old_sync 
Remove references to intialSync etc, and rewrite syncing
 2016-07-13 10:54:02 +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
1c6eed5c35 Fix name of prev_content to preserve on redactions 
The field is called prev_content, not prev_state.
 2016-07-12 16:34:16 +01:00
Richard van der Hoff
6bcb1798f5 Mark deprecated endpoints with their replacements 
Fixes https://matrix.org/jira/browse/SPEC-415
 2016-07-12 16:18:48 +01:00
Richard van der Hoff
9d267795e0 Move /room/x/initialSync to after the undeprecated APIs 
It's a bit incongruous to have to read through the deprecated /initialSync to
get to the good stuff. Separate out intialSync so that we can move it later in
the spec.
 2016-07-12 15:03:20 +01:00
Richard van der Hoff
4118ce6680 Add rationale to /sync 2016-07-12 14:48:03 +01:00
Richard van der Hoff
7186ecba7f Clarify the room-membership APIs 
* give join/invite their own subsection
* move ban/unban into the banning section
* document forgettting and kicking
 2016-07-12 14:18:48 +01:00
Richard van der Hoff
017935d8e9 Fix typo 2016-07-12 14:15:52 +01:00
Richard van der Hoff
6dfc923c1d Remove references to intialSync etc, and rewrite syncing 
The 'Events' section of the C-S spec was full of outdated references to the v1
sync api, which is long dead. (https://matrix.org/jira/browse/SPEC-414).

Also, try to clarify why /sync distinguishes state and timeline
(https://matrix.org/jira/browse/SPEC-423).
 2016-07-12 13:10:36 +01:00
David Baker
4812be9142 Missing . 2016-07-07 15:58:20 +01:00
David Baker
ead5648b8c Add requestToken endpoints 
For password reset and 3pid adding
 2016-07-07 14:52:45 +01:00
David Baker
e4db7be8e2 Better structure for error response 
& add server not trusted error
 2016-06-30 16:22:01 +01:00
David Baker
572aa24a88 Add M_THREEPID_IN_USE 2016-06-30 15:40:20 +01:00
David Baker
ec69f04793 Merge pull request #337 from matrix-org/rav/directory_docs 
Improve documentation of directory API
 2016-06-16 14:14:00 +01:00
Richard van der Hoff
7bbb664784 Improve documentation of directory API 2016-06-16 13:58:45 +01:00
David
92bb1c1b43 Update wording as per request from richvdh 2016-06-13 22:59:52 +08:00
David
a7e40bed88 Add powerlevel name to value list 2016-06-13 10:34:16 +08:00
Richard van der Hoff
099d356dfb Add r0.1.0 to version list in C-S spec 2016-05-13 10:35:22 +01:00
Richard van der Hoff
e7e9f5fa46 Document the /logout api 
We have one, and it's useful, so we really ought to document it
 2016-05-08 22:26:49 +01:00
Richard van der Hoff
3bce28a15c Clarifications to the 'Client authentication' section 
* Use the terminology 'login type' everywhere instead of mixing up 'stage type'
  and 'login type'

* Don't have a separate 'APIs using the User-Interactive Authentication
  mechanism' section, because (a) it doesn't make much sense to organise the
  APIs this way, and (b) it was a set of lies anyway.

* Move '/account/password' definition into registration.yaml so that register
  and password can share a section in the spec; remove duplicate doc for
  /password.

* Write some words on using 3pids for /login
 2016-05-06 17:28:35 +01:00
Richard van der Hoff
351bbee016 Remove changelog from index.rst 
... since it's explicitly unversioned.
 2016-05-05 15:23:21 +01:00
Richard van der Hoff
7d20d2d903 Add old-version links to C-S API 2016-05-05 15:22:39 +01: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
cc0dae3aeb Deduplicate a couple of places where "the" was written twice in a row 2016-03-07 11:31:49 +00:00
Daniel Wagner-Hall
0da26cd7e1 Specify login behaviour for unknown 3pids 2016-01-29 16:49:54 +00:00
Mark Haines
245e8e8571 Add 3pid password login to the spec 2016-01-29 14:42:18 +00:00
Daniel Wagner-Hall
2e46b587b8 Require explicit un-banning 2016-01-15 14:08:40 +00:00
David Baker
169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 2016-01-15 10:04:29 +00:00
David Baker
2301a792d7 Add an error code for invalid user names. 2016-01-14 17:19:04 +00:00
Daniel Wagner-Hall
1e2b63763e /join and /room/:roomId/join aren't exact aliases 
Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
 2016-01-13 15:55:51 +00:00
Daniel Wagner-Hall
5e30d75ccb Add /_matrix/versions to spec 2016-01-06 17:43:20 +00:00
Daniel Wagner-Hall
678dbbe08a s/-/_/ 2015-12-09 17:17:45 +00:00
Daniel Wagner-Hall
4be078440d Don't mention server-server stuff in client-server spec 2015-12-08 15:42:37 +00:00
Daniel Wagner-Hall
217e22fc30 Format changelog more nicely 2015-12-08 13:18:36 +00:00
Daniel Wagner-Hall
19dfafe376 Remove superfluous space 
This causes a <dt> to get rendered around the <tt>s which breaks some
formatting.
 2015-12-08 10:34:48 +00:00