Commit graph

599 commits

Author SHA1 Message Date
Valentin Deniaud
10c3307427 document device_one_time_keys_count in /sync/ response
fix #1157
2018-08-18 11:41:45 +02:00
Valentin Deniaud
8afc82c14b fix /keys/claim request example
It didn't correspond to the example response.
2018-08-18 11:41:45 +02:00
Valentin Deniaud
ab3272045e add missing v1 to m.olm in /keys/upload 2018-08-18 11:41:45 +02:00
Hubert Chathi
f5dc0eaed2
document msisdn-related endpoints in IS (#1507)
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
2018-08-17 12:00:13 -04:00
Travis Ralston
8ac6cea58b
Merge pull request #1522 from turt2live/travis/c2s/http-push-gw-required-path
Require the push gateway URL to be of a specific path
2018-08-17 09:42:17 -06:00
Travis Ralston
4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid
Document OpenID in the client-server and server-server APIs
2018-08-17 08:57:33 -06:00
Travis Ralston
5b30d33b89
Simpler language 2018-08-17 02:51:41 -06:00
Travis Ralston
c891e4a957 Require the push gateway URL to be of a specific path 2018-08-16 12:39:47 -06:00
Travis Ralston
de961fb7d6 Improve wording on push gateways 2018-08-15 11:59:58 -06:00
Travis Ralston
6ad71f785e Improve documentation for pushers and push gateways
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format

Note: this does not attempt to document push rules, just pushers.

Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
2018-08-14 12:51:50 -06:00
Hubert Chathi
292d334509
document new login identifier object (#1390) 2018-08-10 16:19:17 -04:00
Travis Ralston
8ffac01efe Document OpenID in the client-server API
Part of https://github.com/matrix-org/matrix-doc/issues/857

Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
2018-08-07 22:10:11 -06:00
Travis Ralston
2ac80d38d7 Document the /publicRooms endpoint for federation
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476

The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.

The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
2018-08-03 11:23:44 -06:00
Andrew Morgan
54a88eebf0
Merge pull request #1414 from matrix-org/anoa/third_party_cleanup
Clarification on third party fields
2018-08-01 01:38:01 -07:00
user
5f8967c074 Move TODO. field1, field2... -> fields... 2018-07-30 19:21:54 +01:00
user
a2e2ced03b Add reverse-lookup examples. 2018-07-30 11:12:05 +01:00
user
d785ac78a3 Remove explode and replace with TODO, require auth on CS 2018-07-30 11:12:05 +01:00
Andrew Morgan
53137a3c53 c/p bug, fix operationIds, move rst docs to md 2018-07-30 11:09:50 +01:00
Andrew Morgan
273acb277c Change fields to use new extended query array syntax 2018-07-30 11:09:50 +01:00
David Baker
5ddf5374db Missing comma 2018-07-27 12:24:29 +01:00
David Baker
e4fd088fcc Fix room tags spec 2018-07-27 12:05:30 +01:00
Travis Ralston
05fb94e195 Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-18 08:28:16 -06:00
Travis Ralston
d2b0b1bbda
Merge pull request #1379 from turt2live/travis/preset-guests
Document guest_access in /createRoom presets; Make presets a table
2018-07-13 08:42:23 -06:00
Travis Ralston
1829589d23 Convert 3pn errors to new definition 2018-07-12 12:16:11 -06:00
Travis Ralston
197c36c520 Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-12 12:13:07 -06:00
Travis Ralston
91c59e7384
Merge pull request #1353 from matrix-org/anoa/as_thirdparty_lookup
Thirdparty Entity Lookup API
2018-07-12 11:19:12 -06:00
Andrew Morgan
291a4dfc76 Third party lookup module. Fix wording 2018-07-12 16:59:30 +01:00
Travis Ralston
6e3993effe Merge remote-tracking branch 'matrix-org/master' into travis/preset-guests 2018-07-12 09:48:52 -06:00
Travis Ralston
84e07a0c10 Convert errors in presence.yaml 2018-07-12 09:31:50 -06:00
Travis Ralston
16125f16f5 Spec retry_after_ms on ratelimit errors 2018-07-12 09:28:30 -06:00
Travis Ralston
8b513b9f8e Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-12 09:24:04 -06: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
Travis Ralston
fbee83d5cf Clarify some of the properties on the search result
Fixes https://github.com/matrix-org/matrix-doc/issues/773
2018-07-10 15:08:28 -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
516000bdc3 Fix error reference in media repo 2018-07-06 08:53:04 -06:00
Travis Ralston
ab75fc4b20 Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-06 08:46:50 -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
bbf63d116c Fix reference to error.yaml in forget room API 2018-07-05 16:55:11 -06:00
Travis Ralston
55c27d6212
Merge branch 'master' into travis/better-errors 2018-07-05 13:40:17 -06: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