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

412 commits

Author SHA1 Message Date
David Baker
c16ba9488f Spec notifs API 2016-10-05 10:15:49 +01:00
David Baker
1d7531e9a1 Typo 2016-10-04 17:51:35 +01:00
Richard van der Hoff
556ced36a4 Merge remote-tracking branch 'origin/master' into rav/store_and_forward 2016-10-04 11:55:05 +01:00
Erik Johnston
069aa86a10 Update wording and add example to filter param 2016-09-30 15:06:11 +01:00
Erik Johnston
7919e8e159 Update wording. 2016-09-30 15:02:27 +01:00
Erik Johnston
37f6769a3c Spec filter param on /messagse 2016-09-29 13:40:20 +01:00
Erik Johnston
085131b617 Add contains_url filter option 2016-09-29 13:37:08 +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
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
Richard van der Hoff
7478e7f3cf Add top-level account_data to /sync response 2016-08-30 17:43:20 +01: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
Matthew Hodgson
978d9ea6dd fix the descriptions of the /room/.../state APIs to not be the wrong way round 2016-08-18 14:04:21 +01: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
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
Mark Haines
d2fe2f1ff6 Fix jenkins 2016-08-02 13:59:46 +01:00
Mark Haines
618f94699b Document the optional parameter for specifying a filename to download an attachment as 2016-08-02 13:49:54 +01:00
Richard van der Hoff
8328e485ea Clean up the pushrules API doc 
* make it clearer which fields go in which parts of the rule
* the example given appeared to be for a content rule, so use a content rule
  consistently through the examples.
 2016-07-27 13:54:35 +01:00
Richard van der Hoff
7ac2f51e4a /upload: fix example for filename 
The example shouldn't be encoded, else it will be double-encoded by swagger.
 2016-07-25 09:07:42 +01:00
Benjamin Saunders
3e2dea4c52 Document filename query parameter for uploads 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-07-24 23:27:56 -07: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
Erik Johnston
a48437ced8 Spec /account/deactivate API 2016-07-14 10:11:38 +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
7080fd0618 Merge pull request #348 from Ralith/room-messages 
Add missing "to" parameter to /messages
 2016-07-13 11:01:56 +01:00
Benjamin Saunders
dc7fc0309e Add missing "to" parameter to /messages 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-07-12 20:38:53 -07: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
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
David Baker
e91214e78e More links 
Also remove now redundant anchor
 2016-07-08 14:26:18 +01:00
David Baker
cf13c8997c Merge branch 'dbkr/dont_line_wrap_rst' into dbkr/more_requesttokens 2016-07-08 13:54:30 +01:00
David Baker
7c8651480a Some PR feedback corrections 
Including adding a hyperlink, although this requires a separate fix that I'll do on a different branch
 2016-07-08 11:56:23 +01:00
Richard van der Hoff
19a59bc210 Merge pull request #345 from Ralith/require-prev_batch 
Supply prev_batch unconditionally in timelines
 2016-07-07 21:08:56 +01:00
David Baker
c109da5b78 Attempt to make things clearer 2016-07-07 17:07:38 +01:00
David Baker
86db820bb1 Expand on summaries for requestToken endpoints 2016-07-07 16:05:21 +01:00
David Baker
191cb08a3a Add response section otherwise the checker fails 2016-07-07 15:00:27 +01:00
David Baker
d74a320edd Stray tab 2016-07-07 14:58:05 +01:00
David Baker
ead5648b8c Add requestToken endpoints 
For password reset and 3pid adding
 2016-07-07 14:52:45 +01:00
Benjamin Saunders
ee5054fb42 Supply prev_batch unconditionally in timelines 
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-07-07 01:37:48 -07:00
David Baker
14ff3862e3 More PR feedback 2016-07-05 15:15:44 +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
3dddc0dcdf Explain why not erroring on dup 3pid is desireable 2016-06-30 16:13:45 +01:00
David Baker
a600386c05 Consistent working for error response 
Also format json example better
 2016-06-30 16:12:11 +01:00
David Baker
60293af83a PR feedback 2016-06-30 15:25:09 +01:00
David Baker
6a0c9edb49 Add the id_server param 2016-06-30 15:19:44 +01:00
David Baker
b0194a3016 Spec for endpoint-specific 3pid verification token 
As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#
 2016-06-30 14:50:17 +01:00
Richard van der Hoff
4f37e4ece0 Merge pull request #342 from matrix-org/erikj/presence 
Fix and correctly document presence's currently_active
 2016-06-29 11:36:55 +01:00
Erik Johnston
0de8ba7f0a currently_active is a param on GET response, not put 2016-06-29 10:35:31 +01:00