Commit graph

499 commits

Author SHA1 Message Date
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
Richard van der Hoff
2644e5657d
Merge pull request #1152 from turt2live/travis/clarify-whoami
Improve documentation around /account/whoami
2018-03-06 22:54:01 +00:00
Travis Ralston
159ab7313f Fix typos in whoami.yaml
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 15:50:13 -07:00
Travis Ralston
b7f8f20de9 Reword the appservice portion of /account/whoami
Credit goes to richvdh - suggestions taken with edits.

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 15:32:49 -07:00
Travis Ralston
6ba5d7ca92 Reword appservice requirements for /account/whoami
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 15:06:10 -07:00
Richard van der Hoff
a549baa01d
registration.yaml: fix typo
it's -> its
2018-03-06 21:53:16 +00:00
Travis Ralston
2e4e5e25e8 Improve documentation around /account/whoami
Clarifies: https://github.com/matrix-org/matrix-doc/issues/1135

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 13:41:53 -07:00
Travis Ralston
15cdde3f49 Add GET /register/available
Adds https://github.com/matrix-org/matrix-doc/issues/911

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 13:16:07 -07:00
Travis Ralston
d88a1308c2 Formatting and remove DELETE /directory/list
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 10:05:32 -07:00
Travis Ralston
5cbfa73fe4 Improve documentation of /directory/list
* 404 for room not found instead of 400
* GET doesn't require an access token
* PUT (and therefore DELETE) can have it's own access control checks
* DELETE is implemented because of synapse

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-06 08:51:57 -07:00
Travis Ralston
595667d15d Spec /directory/list
Adds https://github.com/matrix-org/matrix-doc/issues/417

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-03 14:46:40 -07:00
Jason Volk
de6d2c96fe Minor grammar fix. 2018-02-13 18:55:36 -08:00
Richard van der Hoff
f7bbcd1678
Merge pull request #1110 from t3chguy/rooms/event
Document new rooms/$/event/$ API for fetching a single event (no ctx)
2018-02-07 12:34:11 +01:00
Michael Telatynski
04eb6c7b65
link to both context and event in depr notice as per review 2018-02-07 08:27:39 +00:00
Michael Telatynski
c5816a80af
move /rooms/{roomId}/event/{eventId} and update depr notice 2018-02-07 08:22:37 +00:00
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
a9c3d94f24
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into rooms/event 2018-01-30 21:27:02 +00:00
Michael Telatynski
a5374c7df7
Document new rooms/$/event/$ API for fetching a single event (no ctx) 2018-01-30 21:24:39 +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