Commit Graph

606 Commits (997562786b95db6369e694c68f33263e623713b3)

Author SHA1 Message Date
Will Hunt d5ce87e956
Split summary up into description and summary 6 years ago
Travis Ralston bbf63d116c Fix reference to error.yaml in forget room API 6 years ago
Travis Ralston 55c27d6212
Merge branch 'master' into travis/better-errors 6 years ago
Travis Ralston 4485b2f025
Merge branch 'master' into travis/server-name-join 6 years ago
Travis Ralston c1c1f28c79
Merge branch 'master' into travis/dont-forget-to-leave 6 years ago
Travis Ralston 3935861445
Merge pull request #1380 from turt2live/travis/define-roomevent
Define RoomEvent on /rooms/{roomId}/messages
6 years ago
Travis Ralston 16860ddd22 De-quote 6 years ago
Andrew Morgan 4c38012122 I can spell 6 years ago
Andrew Morgan e6218b56ab Switch properties to schema 6 years ago
Andrew Morgan a6dad76c01 Fix indentation 6 years ago
Andrew Morgan cc3724b54a fix indentation, error messages. add rest of PR 6 years ago
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>
6 years ago
Travis Ralston 436b410698 Document the error code when someone tries to forget a room they are in 6 years ago
Travis Ralston 9b1f3a1f47 Document guest_access in /createRoom presets; Make presets a table
Previously the presets ended up being rendered as one long string (the indentation was not respected). This was hard to read and wasn't very clear.

Now that there's a larger amount of information, it makes some sense to put it into a table. Tables don't work nicely when nested in another table, so the preset definitions have been moved into the general route description.

This commit also updates the documentation to reference `preset`, not `presets` given the param is singular.

Fixes https://github.com/matrix-org/matrix-doc/issues/881
6 years ago
Travis Ralston 9e796192e4 Document that clients must leave before forgetting rooms
Fixes https://github.com/matrix-org/matrix-doc/issues/1011
6 years ago
Travis Ralston 05c85fd840 Spec the 403 on GET /presence/{userId}/status 6 years ago
Kitsune Ral 981d1004bc Add a missing $ref 6 years ago
Travis Ralston 442ad99727
Merge pull request #1273 from QMatrixClient/content-repo-use-default
Add 'default' to formally enforce the description
6 years ago
Travis Ralston caa6d4d9ad Give all errors a schema reference
This just helps keep an overall structure
6 years ago
Travis Ralston 7cd22f5690 Describe the rate limit error everywhere
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
6 years ago
Travis Ralston 1f12637d3f Getting presence requires authentication 6 years ago
Travis Ralston a6b0125da6 Our swagger doesn't support explode yet 6 years ago
Travis Ralston d279fdafa6 Document the server_name query parameter on /join/{roomIdOrAlias}
Fixes https://github.com/matrix-org/matrix-doc/issues/904
6 years ago
Travis Ralston 7d94aaace8 Explicitly declare that the kick/ban reason will be on the membership event
Fixes https://github.com/matrix-org/matrix-doc/issues/798
6 years ago
Travis Ralston 2409c84968 Document the GET version of /login
Fixes https://github.com/matrix-org/matrix-doc/issues/677
6 years ago
Will Hunt a1309d636c
Remove "Clients should handle gracefully" sentence 6 years ago
Will Hunt 41c18bed0f
+repository 6 years ago
Will Hunt 21e957edfb
Better note for /config 6 years ago
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 7 years ago
Will Hunt 80935eadcf
Update content-repo.yaml 7 years ago
Will Hunt ddc152347b
Extending words and rate limiting 7 years ago
Terrill Tsang f032d6d1c3
Update keys.yaml
Fixed an end to end document bug , a format misleading in an claim response
7 years ago
Will Hunt 1140c0c05b Document StateEvent for /createRoom (#1329) 7 years ago
Will Hunt 6d0a56d190
Suggestions by Travis tend to be sensible ones 7 years ago
Will Hunt 6b9640bcb4
upload_size => m.upload.size 7 years ago
Will Hunt 077cd04a6d
/limits => /config 7 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