Commit graph

482 commits

Author SHA1 Message Date
Michael Telatynski
06911d4fab
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into t3chguy/search_defaults 2018-01-30 21:29:06 +00:00
Michael Telatynski
dc27323d8b
Document the defaults for the /search API 2018-01-30 14:29:59 +00:00
Richard van der Hoff
59e4c625b3
Merge pull request #1093 from CromFr/guest_can_join
Add createRoom guest_can_join parameter
2018-01-24 20:42:08 +00:00
David Baker
fa0eb2405f all rooms, not any, and remove extra words 2018-01-17 11:25:09 +00:00
David Baker
ca09415e80 Fix /keys/changes response to reflect reality 2018-01-17 11:16:48 +00:00
David Baker
bb0bbedb87 indenting 2018-01-10 17:46:25 +00:00
David Baker
1674b0e3b5 Doc /keys/query 'token' param 2018-01-10 17:43:35 +00: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
605510e965
Merge branch 'master' into user_directory 2017-12-18 16:56:04 +00:00
Michael Telatynski
d219cbc978
apply points from review 2017-12-18 16:54:11 +00:00
Richard van der Hoff
00b28495a6 Explain how to split an mxid 2017-12-18 14:48:56 +00:00
Richard van der Hoff
d9a4ddbf65 Mark home_server field deprecated
This is spelt wrong, and is redundant to user_id, so let's stop people using
it.
2017-12-18 13:34:26 +00:00
Michael Telatynski
97445195f6
add user_directory 2017-12-17 23:42:44 +00:00
Gergely Polonkai
e9622bf9e4 Fix example in email based registration endpoint
The spec says `send_attempt` should be a number, but the example shows it as a string.

Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
2017-12-15 13:14:26 +01:00
Crom (Thibaut CHARLES)
b270233549
Add createRoom guest_can_join parameter 2017-12-13 14:12:27 +01:00
Thibaut CHARLES
5e2a48f709
createRoom StateEvent.content should be an object 2017-12-13 00:01:26 +01:00
Kitsune Ral
a68b7e1bbd Supply operationId with freshly added operations
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
2017-11-15 07:37:02 +09:00
Kitsune Ral
b53083732b Merge remote-tracking branch 'remotes/origin/master' 2017-11-15 07:32:44 +09: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
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
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
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