Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-24 01:58:36 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
2775 commits 30 branches 42 tags 32 MiB
Commit graph

634 commits

Author SHA1 Message Date
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 1f12637d3f Getting presence requires authentication 2018-07-04 12:23:51 -06:00
Travis Ralston a6b0125da6 Our swagger doesn't support explode yet 2018-07-03 16:19:31 -06:00
Travis Ralston d279fdafa6 Document the server_name query parameter on /join/{roomIdOrAlias} 
Fixes https://github.com/matrix-org/matrix-doc/issues/904
 2018-07-03 15:49:16 -06:00
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
 2018-07-03 14:59:41 -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
Andrew Morgan d73b247688 3PE lookup service 2018-07-03 14:40:28 +01:00
Will Hunt a1309d636c
Remove "Clients should handle gracefully" sentence 2018-06-29 09:58:07 +01:00
Will Hunt 41c18bed0f
+repository 2018-06-28 17:53:57 +01:00
Will Hunt 21e957edfb
Better note for /config 2018-06-28 17:23:57 +01:00
Will Hunt 1820df02d9
media => content repository 2018-06-28 17:07:44 +01:00
Will Hunt 091b2a6771
Hard limit on requiring accessToken. Rephrased some sections 2018-06-28 16:42:36 +01:00
Will Hunt eeaf4385d7
Speling is my weakniss 2018-06-28 09:04:01 +01:00
Will Hunt 80935eadcf
Update content-repo.yaml 2018-06-28 00:14:42 +01:00
Will Hunt ddc152347b
Extending words and rate limiting 2018-06-27 20:14:29 +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 (#1329) 2018-06-22 16:23:05 +01:00
Will Hunt 6d0a56d190
Suggestions by Travis tend to be sensible ones 2018-06-22 09:38:53 +01:00
Will Hunt 6b9640bcb4
upload_size => m.upload.size 2018-06-20 17:06:17 +01:00
Will Hunt 077cd04a6d
/limits => /config 2018-06-20 16:01:06 +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
Will Hunt ffc8ee298a
a upload > an upload 2018-05-08 11:50:34 +01:00
Will Hunt de6fe1b76e Add note about auth 2018-05-03 18:00:50 +01:00
Will Hunt c9abf36097
size > upload_size 2018-05-03 16:58:22 +01:00
Will Hunt 2783820f98 Initial draft of GET media/limits 2018-05-03 13:54:36 +01: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
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
Maxime Dor 9d2e18cca1 Adapt paths as per feedback 2017-11-15 18:46:27 +01:00
Maxime Dor d1e64daa10 Fix yaml title for directory api 2017-11-15 18:43:16 +01:00
Maxime Dor 28c09aed62 Properly mark required response keys to pass tests 2017-11-15 13:57:52 +01:00
Maxime Dor 8a6103798e Fix for tests 2017-11-15 13:54:55 +01:00
Maxime Dor bb50ec2e88 Document directory query endpoint 2017-11-15 13:40:55 +01:00
Richard van der Hoff 2128924933
Merge pull request #1072 from maxidor/max/ss/version 
Document federation version endpoint
 2017-11-15 07:05:52 +00:00
Maxime Dor 1045bc721d Document federation version endpoint 2017-11-15 04:16:30 +01:00
Kitsune Ral 828086a86c Supply operationId for freshly added IS and AS operations 2017-11-15 07:53:36 +09: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
Kitsune Ral 868af0a7a1 Provide doc-comments with makeHandler(); cleanup 2017-11-15 07:28:25 +09:00
David Baker 5147a3b975 Fix broken links & grammar 2017-11-14 17:14:56 +00:00
David Baker 45af878e11 Merge remote-tracking branch 'origin/master' into dbkr/is_bulk_lookup 2017-11-14 17:11:39 +00:00
David Baker d728e67751
Merge pull request #1068 from matrix-org/dbkr/threepid_add_msisdn 
Document threepids
 2017-11-14 17:05:39 +00:00
Maxime Dor 836e6c81d1 Fix spelling 2017-11-14 15:15:49 +00:00
David Baker e80675c9e9 Link in markdown, not swagger 2017-11-14 15:03:51 +00:00
David Baker 493b936209 Make these links more specific too 2017-11-14 15:01:58 +00:00
Maxime Dor cdfff67878 Create spec for IS bulk lookup 2017-11-14 14:55:16 +00: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
David Baker 6edb90a08e Document threepids 
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid
is and how they work.

This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039
with some tweaks and additions.
 2017-11-14 14:36:38 +00:00
Kitsune Ral 33463e3907 Factor out parser.validate callback 2017-11-14 15:16:42 +09: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