Commit Graph

578 Commits (004998b98f6ec2e1b15c49e3c27674d92ddf6a28)

Author SHA1 Message Date
Will Hunt 1820df02d9
media => content repository 6 years ago
Will Hunt 091b2a6771
Hard limit on requiring accessToken. Rephrased some sections 6 years ago
Will Hunt eeaf4385d7
Speling is my weakniss 6 years ago
Will Hunt 80935eadcf
Update content-repo.yaml 6 years ago
Will Hunt ddc152347b
Extending words and rate limiting 6 years ago
Terrill Tsang f032d6d1c3
Update keys.yaml
Fixed an end to end document bug , a format misleading in an claim response
6 years ago
Will Hunt 1140c0c05b Document StateEvent for /createRoom (#1329) 6 years ago
Will Hunt 6d0a56d190
Suggestions by Travis tend to be sensible ones 6 years ago
Will Hunt 6b9640bcb4
upload_size => m.upload.size 6 years ago
Will Hunt 077cd04a6d
/limits => /config 6 years ago
Michael Telatynski df5455de1f
re-arrange fields in example /search request to make them a valid request. 7 years ago
Michael Telatynski 64f97c5b78
add example of highlights field in /search response 7 years ago
Michael Telatynski 4ff5887c91
spec the highlights field in /search response 7 years ago
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>
7 years ago
Travis Ralston 3dc54b20c6
Merge branch 'master' into travis/clarify-routing-loops 7 years ago
Travis Ralston 8610effad7
Merge branch 'master' into travis/reporting 7 years ago
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>
7 years ago
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>
7 years ago
Travis Ralston 4278cd56a4 Document /logout/all
Fixes https://github.com/matrix-org/matrix-doc/issues/700

Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
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>
7 years ago
Richard van der Hoff bb39bea44d
Merge pull request #1169 from mujx/event-id-format
Use the correct event_id format on examples
7 years ago
Valentin Deniaud 55b512c968 add delete_devices endpoint
fix #1041
7 years ago
Valentin Deniaud 34140a785d fix typo in delete device 7 years ago
Will Hunt ffc8ee298a
a upload > an upload 7 years ago
Will Hunt de6fe1b76e Add note about auth 7 years ago
Will Hunt c9abf36097
size > upload_size 7 years ago
Will Hunt 2783820f98 Initial draft of GET media/limits 7 years ago
Jason Volk 048de9803e Fix typo. 7 years ago
Konstantinos Sideris 7448ef0db0 Use the correct event_id format on examples
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
7 years ago
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>
7 years ago
Richard van der Hoff 2644e5657d
Merge pull request #1152 from turt2live/travis/clarify-whoami
Improve documentation around /account/whoami
7 years ago
Travis Ralston 159ab7313f Fix typos in whoami.yaml
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
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>
7 years ago
Travis Ralston 6ba5d7ca92 Reword appservice requirements for /account/whoami
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Richard van der Hoff a549baa01d
registration.yaml: fix typo
it's -> its
7 years ago
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>
7 years ago
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>
7 years ago
Travis Ralston d88a1308c2 Formatting and remove DELETE /directory/list
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
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>
7 years ago
Travis Ralston 595667d15d Spec /directory/list
Adds https://github.com/matrix-org/matrix-doc/issues/417

Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Jason Volk de6d2c96fe Minor grammar fix. 7 years ago
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)
7 years ago
Michael Telatynski 04eb6c7b65
link to both context and event in depr notice as per review 7 years ago
Michael Telatynski c5816a80af
move /rooms/{roomId}/event/{eventId} and update depr notice 7 years ago
Michael Telatynski 06911d4fab
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into t3chguy/search_defaults 7 years ago
Michael Telatynski a9c3d94f24
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into rooms/event 7 years ago
Michael Telatynski a5374c7df7
Document new rooms/$/event/$ API for fetching a single event (no ctx) 7 years ago
Michael Telatynski dc27323d8b
Document the defaults for the /search API 7 years ago
Richard van der Hoff 59e4c625b3
Merge pull request #1093 from CromFr/guest_can_join
Add createRoom guest_can_join parameter
7 years ago
David Baker fa0eb2405f all rooms, not any, and remove extra words 7 years ago
David Baker ca09415e80 Fix /keys/changes response to reflect reality 7 years ago
David Baker bb0bbedb87 indenting 7 years ago
David Baker 1674b0e3b5 Doc /keys/query 'token' param 7 years ago
Michael Telatynski 784adade9b
changes based on Pull Request feedback 7 years ago
Michael Telatynski 3d8fe6e090
merge profiles with user directory into user data, also fix typo 7 years ago
Michael Telatynski 605510e965
Merge branch 'master' into user_directory 7 years ago
Michael Telatynski d219cbc978
apply points from review 7 years ago
Richard van der Hoff 00b28495a6 Explain how to split an mxid 7 years ago
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.
7 years ago
Michael Telatynski 97445195f6
add user_directory 7 years ago
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>
7 years ago
Crom (Thibaut CHARLES) b270233549
Add createRoom guest_can_join parameter 7 years ago
Thibaut CHARLES 5e2a48f709
createRoom StateEvent.content should be an object 7 years ago
Kitsune Ral a68b7e1bbd Supply operationId with freshly added operations
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
Kitsune Ral b53083732b Merge remote-tracking branch 'remotes/origin/master' 7 years ago
Travis Ralston 0f5a4efce6 Spec URL previews (#1064)
* Spec URL previews
* Require authentication on /upload and /preview_url
7 years ago
Travis Ralston 2468c38482 Add required property to whoami
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Travis Ralston 41db12713d Update whoami endpoint
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Travis Ralston 9cf2b59f4e Make it less obvious where this was copy/pasted from
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Travis Ralston b1801ea6db Spec /account/whoami
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
Kitsune Ral 66268260c7 Merge remote-tracking branch 'remotes/origin/master' 7 years ago
Kitsune Ral 1d4410b638 operationid -> operationId
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
Richard van der Hoff 88fb2e9abd
Merge pull request #1045 from maxidor/max/cs/unknow_filter_status
Add status for unknown user's filter ID
7 years ago
Maxime Dor 099a7e90ae Change return code following feedback 7 years ago
Maxime Dor dcaaf84395 Be clear that event_id is not applicable everywhere 7 years ago
Maxime Dor efa9b5a8f1 Add missing required key for sync format 7 years ago
Maxime Dor 0fea380625 Add status for unknown user's filter ID 7 years ago
Richard van der Hoff 628e723483 Move the MXID spec to the appendices
Also link to them from the /register API doc.
7 years ago
Richard van der Hoff b4e24d443a Clarify what happens when there is no power_levels event 7 years ago
Richard van der Hoff a8afbfd27d Avoid external link in search swagger 7 years ago
Kitsune Ral 004a4d5148 Added/updated operationIds according to today's updates in the spec
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
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>
7 years ago
Michael Telatynski bf3b49f13c document joined_members and joined_rooms endpoints (#999) 7 years ago
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.
7 years ago
Richard van der Hoff a84a34ee6c GETting a filter requires auth (#1003) 7 years ago
Richard van der Hoff 1e3f5683c8 Make clear that the /sync timeout is zero by default 7 years ago
Brendan Abolivier fee65dbacb
Fix response format and 404 example for room alias lookup 7 years ago
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
7 years ago
Richard van der Hoff da6938b818 Key management APIs (#894)
Spec the e2e key-management APIs.
8 years ago
Richard van der Hoff 7adf95b4ad Merge pull request #740 from matrix-org/rav/fix_736
Set default account 'kind' to 'user'
8 years ago
Richard van der Hoff c83a556097 Set default account 'kind' to 'user'
Fixes https://github.com/matrix-org/matrix-doc/issues/736
8 years ago
Richard van der Hoff c175039a08 Final public_rooms clarifications
* order by *joined* members
 * clarify pagination direction behaviour
8 years ago
Richard van der Hoff dca1d0c745 Merge branch 'master' into erikj/public_rooms 8 years ago
Richard van der Hoff 2bf0abcb9d Add missing tag to PUT /devices/{deviceId} 8 years ago
Richard van der Hoff b26c84a290 Fix schema validation fail 8 years ago
Richard van der Hoff 07dbf6fcf6 Add doc for PUT /devices/{deviceId}
Oops, forgot this.
8 years ago
Erik Johnston d66792d5ca Mention order of returned results 8 years ago
Richard van der Hoff af515012ea Device management API 8 years ago
Richard van der Hoff 9265b03008 Client device doc
Document client devices, and the mods to the login and register apis to support
them.
8 years ago
Erik Johnston a69d6c63c6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms 8 years ago