Commit graph

1136 commits

Author SHA1 Message Date
Travis Ralston
36ed6e94a2 Re-introduce signature schemas 2020-05-25 08:16:10 -06:00
Hubert Chathi
6a8ba9b1d6 improve description of key object in CS and include a link in Fed 2020-05-22 16:10:16 -04:00
Hubert Chathi
5b38c04e19 make definition of signatures fields more consistent 2020-05-22 15:50:32 -04:00
Travis Ralston
12ecf9f383
Merge pull request #2561 from matrix-org/travis/doc-2xx-format
Mention that we use OpenAPI 3's response code format
2020-05-21 07:46:51 -06:00
Travis Ralston
1388742a52 Mention that we use OpenAPI 3's response code format
See comments of https://github.com/matrix-org/matrix-doc/pull/2238
2020-05-20 18:00:27 -06:00
Travis Ralston
74b627ac0b Fix the response format of the /send endpoint
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
2020-05-20 17:42:15 -06:00
Kegsay
fc91946e5a
Update api/server-server/backfill.yaml
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2020-05-20 11:07:35 +01:00
Kegan Dougal
9765116c47 Make backfill wording clearer 2020-05-20 10:11:30 +01:00
Travis Ralston
05e83f2e7d Fix more describes -> describe 2020-05-19 09:55:55 -06:00
Travis Ralston
0e771c7b07
Merge pull request #2547 from matrix-org/travis/spec/1802-fix-200
Spec v2 send_join and send_leave endpoints
2020-05-19 08:11:04 -06:00
Travis Ralston
7c0046ffc7 describes -> describe 2020-05-19 08:09:19 -06:00
Travis Ralston
d419e3b38a Remove extraneous spaces 2020-05-19 08:08:31 -06:00
Dominic Fischer
28d460fb62
Fix Typo 2020-05-16 21:35:26 +01:00
Travis Ralston
a2a1694c35 Spec v2 send_join and send_leave endpoints
MSC: https://github.com/matrix-org/matrix-doc/pull/1802

Fixes https://github.com/matrix-org/matrix-doc/issues/2541

This also adds the v2 invite endpoint to the ACL protected list as that appears to be an omission.
2020-05-15 14:10:06 -06:00
Travis Ralston
42ae5c966a Clarify the limits of prev_events and auth_events
Fixes https://github.com/matrix-org/matrix-doc/issues/2307

These restrictions are due to a Synapse change which never made it to the spec prior to the MSC process. This is therefore documenting an omission.

Synapse's numbers are verified here: 207b1737ee/synapse/handlers/federation.py (L1183-L1213)

... and Synapse's handling of the backfill endpoint is described here: 207b1737ee/synapse/handlers/federation.py (L829-L837)

This also includes a mention that https://github.com/matrix-org/matrix-doc/pull/1594 should render the `auth_events` limitation unnecessary. 

No changes are required to the the "checks on receipt of a PDU" section of the server-server spec as it starts with "must be a valid event", to which an event is invalid if it contains too many prev or auth events.
2020-05-12 19:02:39 -06:00
Gnuxie
6b8b31ce63
correct use of required annotation in json-schema
https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.3
2020-05-06 17:10:39 +01:00
Hubert Chathi
0d2924841b
Merge pull request #2524 from uhoreg/e2e_misc_fixes_202005
misc fixes in e2ee spec
2020-05-05 16:10:27 -04:00
Damir Jelić
6e33954256 client-server: Mark the event_id when putting room events as required. 2020-05-05 12:11:51 +02:00
Hubert Chathi
e89521d195 some fixes (spelling, RST, and naming) 2020-05-04 22:08:22 -04:00
Patrick Cloke
1e330c9423 Clarify revocation behavior. 2020-05-04 16:23:31 -04:00
Patrick Cloke
0c582ea8c7
Apply suggestions from code review
Co-authored-by: Travis Ralston <travpc@gmail.com>
2020-05-04 16:21:19 -04:00
Patrick Cloke
958e1b4a2e Make the spec changes for MSC 2457. 2020-05-04 14:36:52 -04:00
Patrick Cloke
fc03f7faa6 Remove query_auth from the specification per MSC2451. 2020-03-24 12:42:15 -04:00
Aaron Axvig
4d808762da Change formatting from italics to code 2020-03-23 12:11:18 -04:00
Örjan Fors
e151ba96ac Fix typo for upgrade
Signed-off-by: Örjan Fors <orion@29k.org>
2020-02-24 09:45:46 +01:00
Isaiah Inuwa
8e888b916c Fix spelling mistakes. 2020-01-18 09:09:42 -06:00
Travis Ralston
f59aa563dd Add missing tags to push rules endpoints
Without the tags, the endpoints don't end up in the swagger. No changelog for this because it doesn't affect the spec itself.
2020-01-01 11:59:37 -07:00
Stuart Mumford
c2ffef051f
Clarify description of user directory
Signed off by Stuart Mumford <stuart@cadair.com>
2019-12-05 09:27:37 -07:00
Travis Ralston
14d609e766
Merge pull request #2344 from matrix-org/travis/spec/fix-2338
Add filter query param to /context
2019-11-06 10:53:21 -07:00
Travis Ralston
9f01850f7a Add some words about where the filter is applied 2019-11-06 10:43:11 -07:00
Travis Ralston
a1e5a96cf8
Update api/client-server/event_context.yaml
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2019-11-06 10:42:08 -07:00
Travis Ralston
8e6e47ae7d
Merge pull request #2343 from matrix-org/travis/spec/fix-2120
Recommend that clients don't preview URLs in encrypted rooms
2019-11-06 09:50:36 -07:00
Travis Ralston
e59bb20dc3 Try to clarify the filter information on /context 2019-11-05 16:08:15 -07:00
Travis Ralston
ef957b990d
Merge pull request #2341 from matrix-org/travis/spec/fix-2298
Clarify that submit_url is without authentication
2019-11-05 16:01:20 -07:00
Travis Ralston
f012da17a1 Explain why e2e previews are bad 2019-11-05 16:00:55 -07:00
Travis Ralston
a50e828509
Merge pull request #2342 from matrix-org/travis/spec/fix-1982
Clarify what format the `country` is on phone number inputs
2019-11-05 07:54:40 -07:00
Travis Ralston
3d954f93b5 Clarify that the room ID is the object key in /sync responses
Fixes https://github.com/matrix-org/matrix-doc/issues/2269
2019-11-04 15:57:58 -07:00
Travis Ralston
021c056efc Add filter query param to /context
This was missed as part of lazy-loading.

Fixes https://github.com/matrix-org/matrix-doc/issues/2338
2019-11-04 15:55:20 -07:00
Travis Ralston
b662a33081 Recommend that clients don't preview URLs in encrypted rooms
Any stronger of a recommendation would probably require a MSC due to the behaviour change. 

Fixes https://github.com/matrix-org/matrix-doc/issues/2120
2019-11-04 15:47:25 -07:00
Travis Ralston
284b15495b Clarify what format the country is on phone number inputs
Fixes https://github.com/matrix-org/matrix-doc/issues/1982
2019-11-04 15:25:49 -07:00
Travis Ralston
e95eafb2ba Clarify that submit_url is without authentication
The request is authorized by its parameters, not by an additional access token.

Fixes https://github.com/matrix-org/matrix-doc/issues/2298
2019-11-04 15:17:51 -07:00
Travis Ralston
2bca44a2e5 Remove extraneous backwards compatibility note 2019-10-28 14:28:48 -06:00
Travis Ralston
f5f12a29e0 Spec MSC2290: 3PID binding split 2019-10-23 19:24:11 -06:00
Travis Ralston
3d60e04c6a
Merge pull request #2310 from matrix-org/travis/spec/2263-deprecate-id-server
Deprecate id_server and make it optional
2019-10-04 16:19:53 -06:00
Travis Ralston
48b8a95df6 Deprecate id_server and make it optional
As per [MSC2263](https://github.com/matrix-org/matrix-doc/pull/2263)
2019-10-03 09:41:45 -06:00
Kitsune Ral
6b37bb1dd9 Merge remote-tracking branch 'remotes/origin/master' into kitsune-map-to-enum-support 2019-10-03 11:06:27 +09:00
Travis Ralston
8d865ca53a Add s2s POST /publicRooms per MSC2197
See https://github.com/matrix-org/matrix-doc/pull/2197
2019-09-24 13:36:51 -06:00
Travis Ralston
2c88f02daa
Merge pull request #2287 from matrix-org/travis/spec/lookup-v2
Spec the v2 lookup API
2019-09-16 08:45:11 -06:00
Travis Ralston
d813b8e12c Mention M_INVALID_PARAM 2019-09-10 09:35:37 -06:00
Travis Ralston
6cfd761204 Spec the v2 lookup API
Spec for [MSC2134](https://github.com/matrix-org/matrix-doc/pull/2134)
2019-09-09 19:58:06 -06:00