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

641 commits

Author SHA1 Message Date
David Baker
493b936209 Make these links more specific too 2017-11-14 15:01:58 +00:00
Maxime Dor
cdfff67878 Create spec for IS bulk lookup 2017-11-14 14:55:16 +00:00
Travis Ralston
0f5a4efce6 Spec URL previews (#1064) 
* Spec URL previews
* Require authentication on /upload and /preview_url
 2017-11-14 14:52:51 +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
Kitsune Ral
33463e3907 Factor out parser.validate callback 2017-11-14 15:16:42 +09:00
Travis Ralston
2468c38482 Add required property to whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-13 18:47:38 -07:00
Travis Ralston
41db12713d Update whoami endpoint 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-13 14:22:20 -07:00
Travis Ralston
9cf2b59f4e Make it less obvious where this was copy/pasted from 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-12 23:56:28 -07:00
Travis Ralston
b1801ea6db Spec /account/whoami 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-11-12 23:49:40 -07:00
Kitsune Ral
77a9daccec Validation that operationId is present 
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-11-13 12:11:11 +09:00
Kitsune Ral
66268260c7 Merge remote-tracking branch 'remotes/origin/master' 2017-11-13 07:46:29 +09:00
Kitsune Ral
1d4410b638 operationid -> operationId 
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-11-13 07:46:03 +09:00
Richard van der Hoff
88fb2e9abd
Merge pull request #1045 from maxidor/max/cs/unknow_filter_status 
Add status for unknown user's filter ID
 2017-11-09 18:29:12 +00:00
Maxime Dor
099a7e90ae Change return code following feedback 2017-11-09 15:32:32 +01:00
Maxime Dor
dcaaf84395 Be clear that event_id is not applicable everywhere 2017-11-09 15:28:44 +01:00
Maxime Dor
efa9b5a8f1 Add missing required key for sync format 2017-11-09 02:10:23 +01:00
Maxime Dor
0fea380625 Add status for unknown user's filter ID 2017-10-29 12:20:22 +01:00
Richard van der Hoff
56c3e5a627 README.rst: Add notes on how to build the spec 2017-10-25 09:57:02 +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
b4e24d443a Clarify what happens when there is no power_levels event 2017-10-17 16:34:50 +01:00
Richard van der Hoff
a8afbfd27d Avoid external link in search swagger 2017-10-15 23:01:54 +01:00
Kitsune Ral
004a4d5148 Added/updated operationIds according to today's updates in the spec 
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-10-11 02:22:19 +09:00
Kitsune Ral
24afe7987c Add operationId to all endpoints of all APIs 
To facilitate generation of API stubs from the spec.

Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
 2017-10-11 01:58:31 +09:00
Michael Telatynski
bf3b49f13c document joined_members and joined_rooms endpoints (#999) 2017-10-10 16:16:27 +01:00
Richard van der Hoff
820704a16a Format examples as raw objects 
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).

The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
 2017-09-27 08:04:24 +01:00
Richard van der Hoff
a84a34ee6c GETting a filter requires auth (#1003) 2017-09-26 14:11:43 +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
fee65dbacb
Fix response format and 404 example for room alias lookup 2017-07-27 17:43:49 +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
7adf95b4ad Merge pull request #740 from matrix-org/rav/fix_736 
Set default account 'kind' to 'user'
 2016-11-22 09:52:19 +00:00
Richard van der Hoff
c83a556097 Set default account 'kind' to 'user' 
Fixes https://github.com/matrix-org/matrix-doc/issues/736
 2016-11-21 17:54:47 +00:00
Richard van der Hoff
c175039a08 Final public_rooms clarifications 
* order by *joined* members
 * clarify pagination direction behaviour
 2016-11-21 13:08:41 +00:00
Richard van der Hoff
dca1d0c745 Merge branch 'master' into erikj/public_rooms 2016-11-21 12:22:08 +00:00
Richard van der Hoff
2bf0abcb9d Add missing tag to PUT /devices/{deviceId} 2016-11-09 14:37:34 +00:00
Richard van der Hoff
b26c84a290 Fix schema validation fail 2016-11-09 14:33:45 +00:00
Richard van der Hoff
07dbf6fcf6 Add doc for PUT /devices/{deviceId} 
Oops, forgot this.
 2016-11-09 14:25:31 +00:00
Erik Johnston
d66792d5ca Mention order of returned results 2016-10-14 10:31:06 +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
Erik Johnston
a69d6c63c6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms 2016-10-11 14:31:47 +01:00
Erik Johnston
cafa9a01fd Move explanation of lack of direction param 2016-10-11 14:29:20 +01:00
Erik Johnston
71c1fc5ec0 Remove spurious 400 result 2016-10-11 14:28:32 +01:00
Erik Johnston
de68c167b6 Add tags for GET endpoint 2016-10-11 14:27:53 +01:00
Erik Johnston
9d0960b206 Better wording 2016-10-11 14:24:46 +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
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