Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-21 17:08:36 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
5313 commits 30 branches 42 tags 32 MiB
Commit graph

1502 commits

Author SHA1 Message Date
Hubert Chathi a1177cbd61
Merge pull request #2566 from uhoreg/remove_string_string_string 
E2E clarifications/improvements
 2020-05-25 13:01:47 -04:00
Travis Ralston b876ac5893 Clarify which server names to sign requests with 
Fixes https://github.com/matrix-org/matrix-doc/issues/2512
 2020-05-25 08:27:55 -06:00
Tulir Asokan 5270ed0c0a Fix typo in read markers module 
Signed-off-by: Tulir Asokan <tulir@maunium.net>
 2020-05-24 14:24:49 +03: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
Travis Ralston 899db411a3
Merge pull request #2433 from matrix-org/travis/spec/msc2324-early-releases 
Attempt to convert MSC2324 (facilitating early releases of implementations) to reality
 2020-05-21 07:41:45 -06:00
Travis Ralston 66ab480967 Incorporate MSC2540 (Canonical JSON validation) 
MSC: https://github.com/matrix-org/matrix-doc/pull/2540
 2020-05-20 22:14:29 -06:00
Travis Ralston 74c51b05a4 Incorporate MSC2209 (notifications auth rules) 
MSC: https://github.com/matrix-org/matrix-doc/pull/2209

The changes are slightly difficult to word without dumping the text in and playing a game of spot the difference, so we now use our pre-existing pygments support to render a representation of the difference. The difference is shown in markdown-like format instead of RST for ease of understanding. It's also not rendered HTML for largely complexity reasons.
 2020-05-20 22:14:29 -06:00
Travis Ralston a1324aa9dc Move MSC2432 (alias handling) to v6 2020-05-20 22:14:11 -06:00
Travis Ralston be35311559 s/should/must for redaction algorithm 
This feels like it was a mistake some time ago considering the redaction algorithm is used in very strict algorithms like event signing.
 2020-05-20 22:14:11 -06:00
Travis Ralston 0300a3cab4 Move redaction algorithm into room version specification 
We stick it in a client section of v1 as the earliest version to define the algorithm is v1, and the client-server spec tells clients to use this algorithm.
 2020-05-20 22:14:11 -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 8220de58bd Drop loudly and instead encourage 2020-05-20 17:48:13 -06:00
Travis Ralston 04e8244dbc
Clarify various bits of wording 
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2020-05-20 17:44:40 -06:00
Travis Ralston 10e4ad72ca
Clarify retention of information for soft logout 
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
 2020-05-19 11:58:28 -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 77d83b9ce5 Clarify that soft logout is about client state 2020-05-19 08:05:47 -06:00
Travis Ralston ddeb695b97
Use 'several' in place of counting 2020-05-18 00:19:30 -06:00
Nicolas Werner a7e7496cd6 Fix some numbers in the spec text. 
Odds were not written as an exponent.
Special tag names count was not updated.

Fixes #2550

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
 2020-05-17 22:20:29 +02:00
Travis Ralston 19cac03305
Update specification/client_server_api.rst 
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
 2020-05-15 22:45:18 -06: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 54102b8d36 Clarify wording per review suggestions 2020-05-15 13:50:17 -06:00
Travis Ralston a15fe3723d Merge master into MSC2342 spec 2020-05-15 13:46:56 -06:00
Travis Ralston b4beb05dde Remove excess whitespace 2020-05-15 13:44:21 -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
Travis Ralston 10293d6951
Merge pull request #2532 from matrix-org/clokep/sso-login 
Add MSC2454 to the specification.
 2020-05-11 14:02:38 -06:00
Patrick Cloke e85f6c31a3
Fix a typo found in review. 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2020-05-11 15:14:11 -04:00
Patrick Cloke 78f8d1322f Add MSC2454 to the specification. 2020-05-08 11:28:59 -04:00
Hubert Chathi a896729ac2 some more clarifications and indentation fixes 2020-05-06 17:11:41 -04:00
Hubert Chathi 0145191d43 add links to endpoints and add delete endpoint 2020-05-05 20:00:45 -04:00
Hubert Chathi 3d1c33ed1b move API definitions into backup section 2020-05-05 18:09:35 -04:00
Hubert Chathi 5f3ee44cfb add more suggestions from review 2020-05-05 18:09:17 -04:00
Hubert Chathi e89521d195 some fixes (spelling, RST, and naming) 2020-05-04 22:08:22 -04:00
David Vo 0ae597626a Fix .m.rule.contains_user_name push rule to highlight 
Signed-off-by: David Vo <david@vovo.id.au>
 2020-05-01 00:32:15 +10:00
Travis Ralston a3385126a7
Merge pull request #2507 from matrix-org/travis/proposal-buckets 
Add some words about what categories are
 2020-04-27 10:06:08 -06:00
Travis Ralston 16905a2f5b Make the spec core team the Spec Core Team 2020-04-22 14:31:34 -06:00
Rudi Floren b5868a59d6
Fix typo in Fed. API request auth python example 
Fixes the typo in the Request Authentication python example. It seems like a copy paste error.

Closes: #2509
Signed-off-by: Rudi Floren <rudi.floren@gmail.com>
 2020-04-22 22:18:28 +02:00
Travis Ralston 3c34d83082 Add some words about what categories are 2020-04-22 13:37:50 -06:00
Lukas Lihotzki af7cf84083 Fix iv parameter description 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2020-04-07 17:54:09 +02:00
Patrick Cloke fc03f7faa6 Remove query_auth from the specification per MSC2451. 2020-03-24 12:42:15 -04:00
Hubert Chathi 9e7bcaac9c
Merge pull request #2465 from uhoreg/state_res_clarification 
clarify first run of iterative auth checks
 2020-03-24 10:36:21 -04:00
Hubert Chathi 30586ed98c remove extra space 2020-03-20 16:55:56 -04:00
Hubert Chathi e67ba0cd05 add note indicating similarity between key backup format and key exports 
also copy description of forwarding_curve25519_key_chain from key exports, since
it's a better description
 2020-03-20 16:49:53 -04:00
Hubert Chathi 2b71234f3c clarify first run of iterative auth checks 2020-03-19 14:39:54 -04:00
Travis Ralston 79b2e5263d
Update specification/proposals_intro.rst 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2020-03-07 14:05:05 -07:00
Runster e6c7eac023
Correct name of Phil Zimmermann 2020-03-06 18:11:28 +01:00
Travis Ralston da795e5824
Apply suggestions from code review 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2020-03-05 17:24:29 -07:00
Travis Ralston 6d475ebd57
Remove whitespace 
Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2020-02-17 12:56:28 -07:00
Travis Ralston c7942d1cec Spec moderation policy rooms (MSC2313) 
MSC: https://github.com/matrix-org/matrix-doc/pull/2313
 2020-02-12 21:58:57 -07:00
Travis Ralston 3ee9a7d654 Attempt to convert MSC2324 to reality 
We've been using this in practice for a while now, so we should document it more officially. 

MSC: https://github.com/matrix-org/matrix-doc/pull/2324
 2020-02-12 21:03:11 -07: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
Nicolas Werner 6911171e83 Fix key export format example 
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
 2020-02-06 09:52:03 +01:00
Aaron Raimist 82a626a98a Fix link to v4 event ID format in identity service spec 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2020-01-02 02:30:29 -06:00
Travis Ralston 912b3cbc95 Move auth events selection to a more appropriate section of the spec 
This was pretty buried, and feels like a common question.
 2019-12-30 16:29:56 -07:00
Hubert Chathi e658b17070 initial version of spec for key backups 2019-12-16 15:47:03 -05:00
Carolin Beer 3aba6e3eeb
Change state_type to event_type 
I couldn't find any other reference to a state_type within the entire specification. I assume this is supposed to be the event_type? This aligns with the description of changes resulting from a state update.
 2019-12-15 14:37:10 +01:00
Travis Ralston ccc7bcabbc id -> ID while we're here 2019-12-07 15:32:43 -07:00
Isaiah Inuwa ad383351c2 Rename nonce to txn_id. Reorganize for clarity. 
Signed-Off-By: Isaiah Inuwa <isaiah.inuwa@gmail.com>
 2019-11-29 10:25:38 -06:00
Alexey Murz Korepov daa610659b
Typo: later user » later use 2019-11-10 16:45:01 +03:00
Travis Ralston 11a7d799a3
Merge pull request #2349 from matrix-org/identity_service/release-r0.3.0 
Identity Service r0.3.0 release
 2019-11-07 08:52:41 -07:00
Travis Ralston 7351c0cd1e Add missing versions to identity spec 2019-11-06 12:47:09 -07:00
Travis Ralston 50647e646e Add r0.6.0 to the list of spec versions. 2019-11-06 12:44:41 -07:00
Travis Ralston 3e035c9172 Make room version 5 the default room version. 
As per [MSC2334](https://github.com/matrix-org/matrix-doc/pull/2334)
 2019-11-05 16:14:04 -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 f5f12a29e0 Spec MSC2290: 3PID binding split 2019-10-23 19:24:11 -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
Travis Ralston eebcaaef02 Point to the new v2 identity endpoint 2019-09-24 13:30:24 -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 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 f7e00b19e9
Merge pull request #2255 from matrix-org/travis/spec/is-auth 
Spec the v2 IS auth APIs
 2019-09-06 10:29:08 -06:00
Travis Ralston 54fb5eb5cf
Merge pull request #2281 from matrix-org/travis/spec/identity-server-storage 
Spec m.identity_server account data
 2019-09-06 10:28:09 -06:00
Charlie Varley 4d835c1753
Update index.rst 2019-09-05 10:31:44 +01:00
Travis Ralston 958cffd330 Spec m.identity_server account data 
As per [MSC2230](https://github.com/matrix-org/matrix-doc/pull/2230)
 2019-09-04 16:17: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 8f48b4e717 Merge branch 'master' into travis/spec/is-auth 2019-09-03 14:03:34 -06:00
Travis Ralston 2b8c8ad512 MSC1779 is actually merged now 2019-09-03 13:49:25 -06:00
Ben Parsons d346099cf7 deduplicate MSC1779 ref in proposals list 2019-09-03 18:30:05 +01:00
Matthew Hodgson 1f2acbcf29 RST is not MD 2019-08-31 16:45:53 +01:00
Travis Ralston 91f862d9e8 Use the right error code for 401 errors 2019-08-28 20:57:07 -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 b0acaeddfa Reference the v2 API where possible 2019-08-28 14:18:11 -06:00
Damir Jelić a96a2f3fce Fix the action of a room key request cancellation. 
The spec states that the action of a room key request cancellation
should be "cancel_request" but every known implementation uses
"request_cancellation" instead.

This patch fixes the spec to reflect the implementations.
 2019-08-26 12:21:23 +02: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
Travis Ralston a171d5f6fd Check for a state_key on the tombstone push rule 
This is an oversight from the proposal.
 2019-08-08 09:29:52 -06:00
Luca Becker f4d6b6c261
Fixed broken indentations 2019-07-23 17:58:40 +02:00
Luca Becker c7a23557d4
Last cosmetic changes 
switched back to the use of `.. NOTE::`
 2019-07-23 17:57:22 +02:00
Luca Becker d43111cdd2
Incorporated @turt2live suggestions. 
Used **Note** to describe notes around the authorisation rules. Otherwise restored the original state for the consequences from the auth rules.
Moved the clarification regarding default power levels up above the auth rules. Removed third sentence. And followed @turt2live's example, but opted for "for users in that room" because the default user power level is applied to all users.
 2019-07-23 11:25:34 +02:00
Luca Becker 094005dca1
Incorporated @turt2live suggestions. 
Added missing added and removed to the rule, because these keys are not required for m.room.power_levels. Also moved the note down to the Note section.
 2019-07-18 08:55:58 +02:00
Luca Becker 8aece4f644
Incorporated @richvdh suggestions 2019-07-17 23:26:10 +02:00
Luca Becker 15994c61a5
Clarification regarding authorisation rules 
The rules for m.room.power_levels power were somewhat unclear regarding the behaviour towards the always present keys, such as kick and ban. Additionally, it is now also clarified that in the users and events dictionary also added and removed keys are taken into consideration.
 2019-07-16 17:33:13 +02:00
Travis Ralston 7b0f5ea77b
Merge pull request #2159 from jimmycuadra/reference-hash-purpose 
Clarify the purpose of reference hashes.
 2019-07-09 16:27:44 -06:00
Jimmy Cuadra a3d2d14dae Rephrase explanation of the purpose of reference hashes and link to the 
room version spec.

Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
 2019-07-09 15:26:03 -07:00
Andrew Morgan 52643a92c6
Less confusing wording on Application Service's Legacy Routes (#2160) 
https://matrix.org/docs/spec/application_service/r0.1.1#legacy-routes

The "becomes" wording made it a little bit confusing for which was the new route and which was the old.
 2019-07-09 17:54:45 +01:00
Jimmy Cuadra 5df86dabe0 Clarify the purpose of reference hashes. 
The server-server specification describes a "reference hash" of an event
and how to calculate it, but is otherwise not mentioned anywhere else in
the document. This change adds a sentence to explain that they are used
for event identifiers in later room versions, which are described in
other documents.

Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
 2019-07-09 01:14:29 -07: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
Andrew Morgan 4997abc4b7 as as -> as 2019-06-25 16:47:10 +01:00
Travis Ralston 6f460ad70a minus spec 
according to the apache .htaccess we use
 2019-06-14 22:26:29 -06:00
Travis Ralston 33ca891e71 Fix link to Olm signing specification 
See https://github.com/matrix-org/matrix.org/issues/478
 2019-06-14 22:22:43 -06:00
Matthew Hodgson aadf1cc733
Merge pull request #2131 from jimmycuadra/e2ee-easier-typo 
Fix typo in key verification framework section.
 2019-06-14 21:56:29 +01:00
Jimmy Cuadra 2dd0da7d50 Fix typo in key verification framework section. 
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
 2019-06-14 13:48:07 -07:00