Commit graph

574 commits

Author SHA1 Message Date
Travis Ralston
bbf63d116c Fix reference to error.yaml in forget room API 2018-07-05 16:55:11 -06:00
Travis Ralston
55c27d6212
Merge branch 'master' into travis/better-errors 2018-07-05 13:40:17 -06:00
Travis Ralston
c1c1f28c79
Merge branch 'master' into travis/dont-forget-to-leave 2018-07-05 10:55:48 -06:00
Travis Ralston
3935861445
Merge pull request #1380 from turt2live/travis/define-roomevent
Define RoomEvent on /rooms/{roomId}/messages
2018-07-05 10:54:54 -06:00
Travis Ralston
16860ddd22 De-quote 2018-07-05 10:46:53 -06:00
Kitsune Ral
dfdc5f9bef search.yaml: Rename some titles to avoid confusion between request and response schemas
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-07-04 20:11:08 -06:00
Travis Ralston
436b410698 Document the error code when someone tries to forget a room they are in 2018-07-04 20:02:30 -06:00
Travis Ralston
9e796192e4 Document that clients must leave before forgetting rooms
Fixes https://github.com/matrix-org/matrix-doc/issues/1011
2018-07-04 15:31:23 -06:00
Kitsune Ral
981d1004bc Add a missing $ref 2018-07-04 14:14:52 -06:00
Travis Ralston
442ad99727
Merge pull request #1273 from QMatrixClient/content-repo-use-default
Add 'default' to formally enforce the description
2018-07-04 14:01:36 -06:00
Travis Ralston
caa6d4d9ad Give all errors a schema reference
This just helps keep an overall structure
2018-07-04 13:54:52 -06:00
Travis Ralston
7cd22f5690 Describe the rate limit error everywhere
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
2018-07-04 13:45:34 -06:00
Travis Ralston
2409c84968 Document the GET version of /login
Fixes https://github.com/matrix-org/matrix-doc/issues/677
2018-07-03 13:41:49 -06:00
Terrill Tsang
f032d6d1c3
Update keys.yaml
Fixed an end to end document bug , a format misleading in an claim response
2018-06-26 17:46:58 +08:00
Will Hunt
1140c0c05b Document StateEvent for /createRoom (#1329) 2018-06-22 16:23:05 +01:00
user
5ab5fe08d1 Small grammatical and stylistic fixes 2018-06-17 15:49:39 +01:00
Michael Telatynski
df5455de1f
re-arrange fields in example /search request to make them a valid request. 2018-06-05 10:12:34 +01:00
Michael Telatynski
64f97c5b78
add example of highlights field in /search response 2018-06-05 10:10:24 +01:00
Michael Telatynski
4ff5887c91
spec the highlights field in /search response 2018-06-05 10:06:26 +01:00
Kitsune Ral
42fba1a87e Add 'default' to formally enforce the description
A quick follow up on #1265.

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-06-03 13:12:59 +09:00
Travis Ralston
3dc54b20c6
Merge branch 'master' into travis/clarify-routing-loops 2018-05-31 11:53:04 -06:00
Travis Ralston
8610effad7
Merge branch 'master' into travis/reporting 2018-05-31 10:57:33 -06:00
Travis Ralston
7cc15f3315 Document the allow_remote query param on the media repo
Fixes https://github.com/matrix-org/matrix-doc/issues/837

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-05-27 12:34:58 -06:00
Travis Ralston
9037f506ac Document how to report content
Fixes: https://github.com/matrix-org/matrix-doc/issues/739

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-05-27 12:19:30 -06:00
Travis Ralston
4278cd56a4 Document /logout/all
Fixes https://github.com/matrix-org/matrix-doc/issues/700

Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-05-27 11:45:36 -06:00
Florian Jacob
cc54a4f8cb /rooms/{roomId}/members: specify access_token requirement
as the behaviour of which members the users see is user-specific
and therefore requires authentication.

Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
2018-05-17 18:51:08 +02:00
Richard van der Hoff
bb39bea44d
Merge pull request #1169 from mujx/event-id-format
Use the correct event_id format on examples
2018-05-17 08:36:09 +01:00
Valentin Deniaud
55b512c968 add delete_devices endpoint
fix #1041
2018-05-16 11:50:21 +02:00
Valentin Deniaud
34140a785d fix typo in delete device 2018-05-14 16:02:48 +02:00
Jason Volk
048de9803e Fix typo. 2018-04-22 22:57:40 -07:00
Konstantinos Sideris
7448ef0db0 Use the correct event_id format on examples
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
2018-04-03 13:18:29 +03:00
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
e4f7ba70f5
Merge branch 'master' into travis/spec-directory-list 2018-03-05 14:53:06 -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
Maxime Dor
c8393306d1 Add IS ping endpoint 2018-02-27 17:54:42 +01: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