Commit Graph

523 Commits

Author SHA1 Message Date
Andrew Morgan 291a4dfc76 Third party lookup module. Fix wording 2018-07-12 16:59:30 +01:00
Andrew Morgan 8999887245 Path -> query params 2018-07-12 14:44:48 +01:00
Andrew Morgan 9bde78ac28 $ref needs to be under a schema: 2018-07-12 14:41:24 +01:00
Andrew Morgan 114bcf1a2e Use $ref, clean up, fix errors, AS is now a C-S module. 2018-07-12 14:31:34 +01:00
Andrew Morgan 4c38012122 I can spell 2018-07-05 12:58:42 +01:00
Andrew Morgan e6218b56ab Switch properties to schema 2018-07-05 11:59:10 +01:00
Andrew Morgan a6dad76c01 Fix indentation 2018-07-05 11:56:30 +01:00
Andrew Morgan cc3724b54a fix indentation, error messages. add rest of PR 2018-07-05 11:55:25 +01: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 () 2018-06-22 16:23:05 +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
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 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 
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 ()
* 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 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 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 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