Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-21 00:48:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
5313 commits 29 branches 42 tags 32 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
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
Travis Ralston 642be6c677 Fix unbind wording 2019-09-06 13:06:16 -06:00
Travis Ralston 30a9de7e02 Merge branch 'master' into travis/spec/is-unbind 2019-09-06 13:05:19 -06:00
Travis Ralston a24bcc2c0a
Merge pull request #2258 from matrix-org/travis/spec/is-terms 
Spec IS terms of service
 2019-09-06 10:29:47 -06:00
Travis Ralston 1881a255c2 Clarify that id_access_token is optional for r0.5 2019-09-05 13:53:58 -06:00
Travis Ralston 185c564a13 Spec client-server IS unbind API 
As per [MSC2140](https://github.com/matrix-org/matrix-doc/pull/2140)

Note: this modifies the endpoint in MSC2140 to be more in line with the remainder of the proposal.
 2019-09-04 16:38:15 -06:00
Travis Ralston 2d784d93ef Merge branch 'master' into travis/spec/is-auth 2019-09-04 16:35:50 -06:00
Travis Ralston 001c51a740 /3pid/delete and /deactivate don't take an id_access_token 2019-09-03 15:09:59 -06:00
Travis Ralston 52e6868f50 Remove bind_* params on /register as per MSC2140 
See https://github.com/matrix-org/matrix-doc/pull/2140
See https://github.com/matrix-org/matrix-doc/issues/2253
 2019-09-03 15:03:41 -06:00
Travis Ralston afd5018494 Spec the terms of service handling for identity servers 
Part of MSC2140

Convert status codes to strings if there is a string status code. Fixes a build error when we mix 4xx and 403 in the same definition. We also have to correct stringified numbers to pass the build.
 2019-09-03 14:04:05 -06:00
Travis Ralston 0408373cf9 Litter the client-server API with id_access_token 2019-08-28 15:47:08 -06:00
Travis Ralston 4d0ea64121 Define authentication, ripping off the client-server API description 2019-08-28 15:46:58 -06:00
Travis Ralston e40d9e296d Split OpenID token info out verbatim 2019-08-28 15:46:58 -06:00
Travis Ralston ca4d9d8636 Deprecate the v1 IS API 2019-08-28 14:19:13 -06:00
Travis Ralston a47c5aeb42 v2-ify the v2 api 
Note that ping and pubkey doesn't require auth - see MSC2140 for more information.
 2019-08-28 14:17:51 -06:00
Travis Ralston 5b53b3d0b8 Clone v1 APIs verbatim 2019-08-28 14:01:36 -06:00
Travis Ralston b8a3f970ee Add security definition for access token 2019-08-28 13:40:48 -06:00
Kitsune Ral 65cd10249c Render enums inside additionalProps as one more table 
Closes #2242.
 2019-08-24 21:56:48 +09:00
Andrew Morgan 92c6f4c38e
Add M_USER_DEACTIVATED to list of error codes (#2234) 
Spec PR for [MSC 2181](https://github.com/matrix-org/matrix-doc/pull/2181).

Adds the `M_USER_DEACTIVATED` error code and a short description to the client-server API.
 2019-08-15 18:10:38 +01:00
Dominic Fischer a63fab20ee Fix some typos 
Signed-off-by: Dominic Fischer <dominicfischer7@gmail.com>
 2019-08-03 18:07:22 +01:00
Andrew Morgan af60889eee
Clarify that /rooms/{roomId}/event/{eventId}'s 404 should be M_NOT_FOUND (#2204) 
No error code is specified for this endpoint's 404. State that it should be an `M_NOT_FOUND`.
 2019-07-31 15:14:38 +01:00
Travis Ralston 2a2dddab94
Merge pull request #2151 from reivilibre/push_id_event_id 
Fix Push Gateway API example: Field renamed to event_id
 2019-07-25 10:31:13 -06:00
Alexey Andreyev 9ed19a37ad
Client-server: Fix upload keys example request 
Contributes to #1733

Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
 2019-07-08 22:28:32 +03:00
J. Ryan Stinnett 4c65660b96 Clarify .m.rule.room_one_to_one push rule 
This clarifies the `.m.rule.room_one_to_one` push rule by adding a condition on
event type. Some parts of the spec already had this info, while others were
missing it. Synapse has had this behaviour since the push rule appeared.

Fixes https://github.com/matrix-org/matrix-doc/issues/2150
 2019-07-03 10:59:38 +01:00
reivilibre 8033ab1c86 Fix Push Gateway API example: Field renamed to event_id 
I believe this was forgotten in:
71cb646541
 2019-07-03 10:36:16 +01:00
Travis Ralston cac72ff873
Merge pull request #2126 from matrix-org/travis/403-id-unbind 
Add 403 error to IS unbind
 2019-06-13 06:25:28 -06:00
Travis Ralston 67ea3b9ce8 Add 403 error to IS unbind 
Fixes https://github.com/matrix-org/matrix-doc/issues/2117
 2019-06-12 15:41:10 -06:00
Travis Ralston b8f1f37927 Remove incorrect id_server param from IS spec 
Fixes https://github.com/matrix-org/matrix-doc/issues/2118
 2019-06-12 15:29:25 -06:00
Travis Ralston 8f1f8b4fe5 Fix references to filtering 
We can't have two different backlinks for the same text, so use LL as the label
 2019-06-11 11:28:35 -06:00
Travis Ralston 8ac555f870
Merge pull request #2083 from matrix-org/travis/1.0/key-object 
Clarify the key object definition for the key management API
 2019-06-11 09:50:34 -06:00
Travis Ralston 8b7887dfc2 Link to key algorithms section 2019-06-11 09:47:02 -06:00