wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
5313 commits 4 branches 0 tags 17 MiB
Commit graph

1206 commits

Author SHA1 Message Date
Travis Ralston
06b0c1762a Move the send_join response to its own definition 
Both APIs need clarification, so dedupe the changes.

We should also probably deprecate some of this stuff so we can eventually remove it.
 2020-05-25 09:55:32 -06:00
Travis Ralston
200212ffd7 Clarify that a creation event and member event are needed for createRoom 
Fixes https://github.com/matrix-org/matrix-doc/issues/2494
 2020-05-25 08:33:08 -06:00
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
b11cf560b5 Add spec for new alias handling (client-server) 
MSC: https://github.com/matrix-org/matrix-doc/pull/2432

This commit does not deal with areas which will be covered by the room version specifications (namely the redaction algorithm).

It feels a bit overly cruel to completely obliterate all mentions of `m.room.aliases` from the spec as client/server developers may encounter the event type in the wild. To ensure that CTRL+F still works, a brief mention that they do nothing has been put in place, leaving no other references (except the redaction algorithm - see previous paragraph).
 2020-05-20 20:10:52 -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
d24f15a3a9 Spec soft-logout per MSC1466 
MSC: https://github.com/matrix-org/matrix-doc/issues/1466
 2020-05-15 13:41:13 -06:00
Hubert Chathi
fae1165e1c spec what to do if you try to delete a backup that's already deleted 2020-05-15 12:17:37 -04:00
Hubert Chathi
bd95568c8c remove duplicate key 2020-05-13 19:27:36 -04:00
Hubert Chathi
1bae8ea633 we actually don't support the GET /room_key/versions/ with trailing slash 2020-05-13 19:24:34 -04: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
Kitsune Ral
ff59fc1905 /keys/query: Add a title in the response 
The device keys structure in queryKeys is not the same as the one
defined in device_keys.yaml (it adds things on top of it).

Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2020-05-08 07:48:28 +02:00
Kitsune Ral
77783b8fc3 Remove extraneous quotes, fix a typo 
filter.yaml: quotes under |- were taken literally.
notifications.yaml: it's a number in the example, not a string
 2020-05-08 07:48:28 +02:00
Hubert Chathi
a896729ac2 some more clarifications and indentation fixes 2020-05-06 17:11:41 -04: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
0145191d43 add links to endpoints and add delete endpoint 2020-05-05 20:00:45 -04:00
Hubert Chathi
5f3ee44cfb add more suggestions from review 2020-05-05 18:09:17 -04:00
Hubert Chathi
8ff1c26ef2 fix indentation 2020-05-05 17:28:54 -04:00
Hubert Chathi
e0b4a3c912
Apply suggestions from code review 
Co-authored-by: Travis Ralston <travpc@gmail.com>
 2020-05-05 17:02:16 -04: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
Kitsune Ral
202bf8abb1 Cleanup summaries and descriptions 2020-04-29 20:15:06 +02: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
Hubert Chathi
41072fcaa9
Apply suggestions from code review 
Co-Authored-By: Matthew Hodgson <matthew@arasphere.net>
 2020-02-07 15:28:19 -05: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
Hubert Chathi
a62c817745
Apply suggestions from code review 
Co-Authored-By: Matthew Hodgson <matthew@arasphere.net>
 2019-12-17 11:07:04 -05:00
Hubert Chathi
4cde800ea1 fix validation errors 2019-12-16 17:25:20 -05:00
Hubert Chathi
59e337187b remove duplicated line 2019-12-16 15:54:42 -05:00
Hubert Chathi
e658b17070 initial version of spec for key backups 2019-12-16 15:47:03 -05: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