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

436 commits

Author SHA1 Message Date
David Baker
49ee00c361 Use the right path for the identity API 2016-10-07 18:17:45 +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
David Baker
e0a434b248 Aaha, found a syntax that swagger will accept! 2016-10-06 11:20:05 +01:00
David Baker
bd753d4bf4 Re-add required flags the correct way 2016-10-05 18:53:08 +01:00
David Baker
af2c74c186 Revert requireds 
They're not boolean flags for object fields
 2016-10-05 18:50:14 +01:00
David Baker
14944fe237 More PR feedback 2016-10-05 18:26:42 +01:00
David Baker
fd8c1a43c7 ms, not s. Also add required flags 2016-10-05 18:22:03 +01:00
David Baker
b789251f70 More PR feedback 2016-10-05 12:59:49 +01:00
David Baker
4a020025bc Make swagger happpy 
These aren't strings, but 'any' causes swagger to break and
leaving it out makes the doc fail to build.
 2016-10-05 11:51:48 +01:00
David Baker
b4c89accb2 Params in query, not path 2016-10-05 11:48:14 +01:00
David Baker
a463820d83 Typo 2016-10-05 11:21:56 +01:00
David Baker
c1fa342b90 Swagger is failing on type 'any' 2016-10-05 11:21:06 +01:00
David Baker
136d5dc9ad Almost valid... 2016-10-05 11:15:33 +01:00
David Baker
595b75f299 Try & make example closer to valid 2016-10-05 10:32:03 +01:00
David Baker
41781e95b2 Attempt valid json 2016-10-05 10:21:29 +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
1d7531e9a1 Typo 2016-10-04 17:51:35 +01:00
David Baker
d39f662df5 PR feedback 2016-10-04 11:57:24 +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
David Baker
8fe8bd6a81 Add is_direct to member event spec. 2016-10-03 17:33:45 +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
David Baker
5fedc64230 double space 2016-10-03 15:52:08 +01:00
David Baker
ae1c576648 Merge remote-tracking branch 'origin/master' into erikj/create_room_is_direct 2016-10-03 15:17:55 +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
b121feebce Comment what the is_direct flag actually does 2016-09-30 11:24:51 +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
Erik Johnston
3a5cbd14c3 Add /createRoom is_direct flag 2016-09-29 11:25:12 +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