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

121 commits

Author SHA1 Message Date
Ben Parsons
07aeaadef9 update links which used to point to docs/spec/intro 2018-07-24 11:41:03 +01:00
Travis Ralston
423d5593f5 Generify how OPTIONS and CORS are handled 2018-07-09 15:40:03 -06:00
Travis Ralston
0779d81e52 Clarify which requests should have CORS headers 
Spoilers: all of them.
 2018-07-04 14:30:39 -06:00
Travis Ralston
4ca54404fa Document the CORS/preflight headers 
Fixes https://github.com/matrix-org/matrix-doc/issues/1006
 2018-07-03 16:15:55 -06: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
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
Michael Telatynski
784adade9b
changes based on Pull Request feedback 2017-12-21 17:45:26 +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
97445195f6
add user_directory 2017-12-17 23:42:44 +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
Travis Ralston
b1801ea6db Spec /account/whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-12 23:49:40 -07: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
a8afbfd27d Avoid external link in search swagger 2017-10-15 23:01:54 +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
1e3f5683c8 Make clear that the /sync timeout is zero by default 2017-08-31 16:56:50 +01: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
8a9629167a httpsify the speculator link 2016-11-27 17:28:56 +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
22777970da Fix speculator link 
the link to the 'latest version' was broken
 2016-10-13 17:56:53 +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
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
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
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
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
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
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
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
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