Commit graph

599 commits

Author SHA1 Message Date
Travis Ralston
374ec00046 Convert things that mention "Transaction" to swagger
There's two kinds of transactions currently: one with EDUs and one without. The one with EDUs is only used on /send, however the schema is still somewhat worth splitting out for simplicity.

The examples are brought apart to make them slightly more reusable for when they get dumped into the relevant sections of the spec (see TODO in server_server_api.rst)

Further, the Transactions stuff introduces tuples to the spec. The units.py has been updated to support this.
2018-07-11 16:52:27 -06:00
Travis Ralston
d7a979da63 Merge remote-tracking branch 'matrix-org/master' into travis/all-the-auth 2018-07-06 11:33:24 -06:00
Travis Ralston
e7a6ff1064
Merge branch 'master' into travis/spec-reason 2018-07-06 07:02:11 -06:00
Travis Ralston
1722734a51
Merge pull request #1364 from turt2live/travis/server-name-join
Document the server_name query parameter on /join/{roomIdOrAlias}
2018-07-06 07:00:24 -06:00
Will Hunt
ff3c379339
Merge pull request #1189 from Half-Shot/hs/upload-limits
GET media/config 🎉
2018-07-06 11:37:35 +00:00
Will Hunt
77f4ac54aa
Wordy intro sentence for description 2018-07-06 10:36:17 +01:00
Will Hunt
2e6cc8045c
Better indent of description 2018-07-06 10:29:05 +01:00
Will Hunt
d5ce87e956
Split summary up into description and summary 2018-07-06 10:27:03 +01:00
Travis Ralston
4485b2f025
Merge branch 'master' into travis/server-name-join 2018-07-05 11:23:13 -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
Travis Ralston
05c85fd840 Spec the 403 on GET /presence/{userId}/status 2018-07-04 14:37:21 -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
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
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