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

1430 commits

Author SHA1 Message Date
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
Travis Ralston 50dee76fa7
Merge pull request #2122 from matrix-org/travis/fix-changelog 
Fix changelog generation
 2019-06-13 19:19:32 -06:00
Travis Ralston 18eca90022 Exclude DEL from historical user IDs 
The range is inclusive, so don't include 7F
 2019-06-12 13:48:50 -06:00
Travis Ralston e60d2defbd Fix changelog generation 
Only include the target version, not all versions. Additionally, make sure the appservice spec isn't hardcoded as "unstable".
 2019-06-12 13:47:09 -06:00
Travis Ralston 19a3d574b7 Fix HKDF rationale 2019-06-11 11:31:24 -06:00
Travis Ralston ba5479e46f Reference Canonical JSON 2019-06-11 11:30:04 -06:00
Travis Ralston 98c9d93b20
Merge pull request #2113 from matrix-org/client_server/release-r0.5.0 
Client-Server r0.5.0
 2019-06-11 10:54:06 -06:00
Travis Ralston 497c6875ac
Merge pull request #2112 from matrix-org/server_server/release-r0.1.2 
Federation r0.1.2
 2019-06-11 10:53:56 -06:00
Travis Ralston 67d12165e8
Merge pull request #2111 from matrix-org/identity_service/release-r0.2.0 
Identity r0.2.0
 2019-06-11 10:53:44 -06:00
Travis Ralston 1ca60bf5d7 Client-Server r0.5.0 2019-06-11 10:40:48 -06:00
Travis Ralston 8e6ccf0a0e Federation r0.1.2 2019-06-11 10:38:12 -06:00
Travis Ralston 34ad81e81b Identity r0.2.0 2019-06-11 10:30:56 -06:00
Travis Ralston 4f915f2760 Appservice r0.1.1 2019-06-11 10:15:51 -06:00
Travis Ralston f44483a8cf
Merge pull request #2099 from matrix-org/travis/1.0/1.0-notice 
Declare Matrix 1.0 in the index
 2019-06-11 09:56:55 -06:00
Travis Ralston 2d18f81807
Merge pull request #2087 from matrix-org/travis/1.0/events-are-extensible 
Reorganize event structure in c2s spec and clarify event capabilities
 2019-06-11 09:55:17 -06:00
Travis Ralston c9345ba6a3 Never forget the past 2019-06-11 09:53:36 -06:00
Travis Ralston 19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading 
Spec lazy-loading room members
 2019-06-11 09:39:32 -06:00
Travis Ralston fbdb56a29f
Merge pull request #2101 from matrix-org/anoa/hs_3pid_tokens 
Add submit_url field to requestToken responses, clarify HS's can send tokens themselves
 2019-06-11 09:25:53 -06:00
Travis Ralston 6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms 
Spec v5 rooms: Key validity
 2019-06-11 08:51:25 -06:00
Travis Ralston b32f0e768f clarify that UIA can now be done by the HS 2019-06-11 08:47:40 -06:00
Travis Ralston 370ae8b9fe
Merge pull request #2068 from matrix-org/travis/1.0/mxc 
Refactor documentation for content/media repository
 2019-06-11 08:32:06 -06:00
Travis Ralston ad3aa5edf0
Merge pull request #2104 from matrix-org/travis/1.0/event-ids 
Clarify that the common identifier format can be broken
 2019-06-11 07:51:34 -06:00
Travis Ralston b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes 
Specify some of the common concepts for Matrix in the index
 2019-06-11 07:51:06 -06:00
Travis Ralston c1c26859e2
Merge pull request #2096 from matrix-org/travis/1.0/read-notifs 
Clarify how notification counts are calculated in /sync
 2019-06-11 07:50:33 -06:00
Travis Ralston ad2eefdde9 Shuffle and clarify identifier grammar 
Specifically, make it clearer that event IDs are the weird exception in this section.
 2019-06-10 14:23:04 -06:00
Travis Ralston 32761fc108
Merge pull request #2098 from matrix-org/travis/1.0/modules-update 
Clarify what a "module" is and update feature profiles for clients
 2019-06-10 14:05:15 -06:00
Travis Ralston 37e2d81d58 Hardcode the state event fields table into the spec 
See comment for why.
 2019-06-10 14:04:27 -06:00
Travis Ralston 51698a5dd5 Clarify that people must own the namespace to use it 2019-06-10 14:04:14 -06:00
Travis Ralston 19c827e581 Remove trailing slashes section 2019-06-10 13:49:05 -06:00
Travis Ralston 49831fb74f Clarifications about namespaces 2019-06-10 13:48:55 -06:00
Travis Ralston 1886a2346a Move explanation of notifications to notifications module 2019-06-10 13:38:43 -06:00
Travis Ralston cf19f52576 Enforce 7 day validity requirement everywhere 
also misc formatting fixes
 2019-06-10 13:21:24 -06:00
Matthew Hodgson 0506d09cf7 incorporate LL review from matthew 2019-06-10 19:38:44 +01:00
Travis Ralston 7fe7d365e2
Merge pull request #2089 from matrix-org/travis/1.0/cors 
Clarify when and where CORS headers should be returned
 2019-06-10 07:21:52 -06:00
Travis Ralston 29340c6eb8 Clarify that the common identifier format can be broken 
We already reference in the Event IDs section that the format depends on the room version, so we just need to link there.

Fixes https://github.com/matrix-org/matrix-doc/issues/2103
 2019-06-09 22:50:23 -06:00
Matthew Hodgson 950415c72a
Merge branch 'master' into matthew/msc1779 2019-06-07 19:19:19 +01:00
Travis Ralston a38af2009f
Apply suggestions from code review 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2019-06-07 10:37:57 -06:00
Travis Ralston 4b6e2cc956
Merge pull request #2072 from matrix-org/travis/1.0/msc1717-msc1267-sas-verification 
Spec SAS verification and the common key verification framework
 2019-06-07 10:34:08 -06:00
Travis Ralston 46747e897e ing 2019-06-07 10:32:06 -06:00
Travis Ralston 00588efd3f
Merge pull request #2086 from matrix-org/travis/1.0/fed-content-type 
Clarify that the default s2s transport is JSON over HTTP
 2019-06-07 10:12:59 -06:00
Travis Ralston ac27728c0a
Merge pull request #2082 from matrix-org/travis/1.0/v4-default 
Make v4 the "default" room version
 2019-06-07 10:11:49 -06:00
Travis Ralston e4339fd687 More clarity 2019-06-07 09:01:14 -06:00
Travis Ralston 6a4a6db1bd
Merge pull request #2081 from matrix-org/travis/1.0/pdu-signatures 
Clarify which servers are supposed to sign events
 2019-06-07 08:56:14 -06:00
Travis Ralston 4c82553df4
Merge pull request #2047 from matrix-org/travis/1.0/test-vectors 
Fix test vectors with invalid JSON and signature
 2019-06-07 08:54:35 -06:00
Travis Ralston 360ac0b900
Update specification/server_server_api.rst 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2019-06-07 08:54:21 -06:00
Travis Ralston 77c4c4b07c Add general clarity 2019-06-07 08:27:18 -06:00
Travis Ralston 5ec1a50b94 Linefeeds and other clarifications 2019-06-07 08:12:09 -06:00
Travis Ralston 3877896a4c Clarify how we now expect verification to be done 2019-06-07 08:10:52 -06:00
Travis Ralston d49c7fb3b0
Apply suggestions from code review 
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2019-06-07 08:01:17 -06:00
Travis Ralston 00fee74636 Update example 2019-06-07 07:40:52 -06:00
Travis Ralston f4e85853d4
Merge pull request #2054 from matrix-org/travis/1.0/uia-clarifications 
Clarify that UIA stages cannot be attempted twice
 2019-06-07 07:38:40 -06:00
Jamie McClymont d7858354f2 Fix 404s in links from room v1 spec 2019-06-07 20:54:47 +12:00
Travis Ralston 7f01346bba Provide a more complete example of a "minimally-sized event" 
Using all the required fields of a v1 event.
 2019-06-06 23:50:26 -06:00
Travis Ralston ae9abe798e Revert signature change for redactable event test 
The previous signature was calculated on the unredacted event, which means the signature produced was wrong.
 2019-06-06 23:41:51 -06:00
Travis Ralston 4f665f06e6 Clarify what Matrix 1.0 is further 
And add a table for minimum versions.
 2019-06-06 17:42:37 -06:00
Travis Ralston 06ee60f004 Clarify what compliant implementations are 2019-06-06 17:32:59 -06:00
Travis Ralston 49dbb3ee4f Declare Matrix 1.0 in the index 
Fixes https://github.com/matrix-org/matrix-doc/issues/2044
 2019-06-06 17:26:27 -06:00
Travis Ralston 87d8d97074 Remove incomplete and weird sentence 2019-06-06 17:19:08 -06:00
Travis Ralston cd6b012523 Clarify what a "module" is and update feature profiles for clients 
Fixes https://github.com/matrix-org/matrix-doc/issues/2009
 2019-06-06 17:07:49 -06:00
Travis Ralston b9c9396c11 Specify some of the common concepts for Matrix in the index 
See https://github.com/matrix-org/matrix-doc/pull/2061
Fixes https://github.com/matrix-org/matrix-doc/issues/1468
Fixes https://github.com/matrix-org/matrix-doc/issues/1528

The section is not referenced by the specifications yet - they do a fairly good job of explaining it over and over. In future, it would be good to point all the references to the index.
 2019-06-06 15:59:54 -06:00
Travis Ralston f0eb495cee Clarify how notification counts are calculated in /sync 
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
 2019-06-06 15:41:28 -06:00
Travis Ralston e644227f4b Clarify that the server shouldn't process retries for UIA 2019-06-06 14:13:20 -06:00
Travis Ralston e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn 
Spec MSISDN UIA support
 2019-06-06 10:24:34 -06:00
Travis Ralston bbc7401973 Clarify when and where CORS headers should be returned 
Fixes https://github.com/matrix-org/matrix-doc/issues/1736
Fixes https://github.com/matrix-org/matrix-doc/issues/2013
 2019-06-05 23:14:33 -06:00
Travis Ralston 8fd5b15594 Reorganize event structure in c2s spec and clarify event capabilities 
Fixes https://github.com/matrix-org/matrix-doc/issues/1166
Fixes https://github.com/matrix-org/matrix-doc/issues/1527
Fixes https://github.com/matrix-org/matrix-doc/issues/1827

Note: In order to fix the "state events have the following fields: [no words]" bug (1827) we need to resolve references on common event types. When doing this we ultimately end up with more fields than may be required to explain the section, however this commit alters the section descriptions to just say "these fields" instead of "these additional fields".

This is also preferable over trying to get the inheritance reversed in the common event types, as the `/sync` endpoint has a high amount of reliance on partial events definitions.
 2019-06-05 22:55:11 -06:00
Travis Ralston 500f3d3bf1 Clarify that the default s2s transport is JSON over HTTP 
Fixes https://github.com/matrix-org/matrix-doc/issues/1713
 2019-06-05 22:28:57 -06:00
Travis Ralston 80aa5a24dc Make v4 the "default" room version 
As per [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002). This was missed in https://github.com/matrix-org/matrix-doc/pull/2019

Fixes https://github.com/matrix-org/matrix-doc/issues/2071
 2019-06-05 20:33:09 -06:00
Travis Ralston 7ce1ff2135 Clarify which servers are supposed to sign events 
Fixes https://github.com/matrix-org/matrix-doc/issues/2074
 2019-06-05 20:30:21 -06:00
Travis Ralston a6314df44c Spec v5 rooms: Key validity 
Proposals:
* [MSC2076](https://github.com/matrix-org/matrix-doc/pull/2076)
* [MSC2077](https://github.com/matrix-org/matrix-doc/pull/2077)

Implementation references:
* 00bf99fa62
* https://github.com/matrix-org/synapse/pull/5354
* https://github.com/matrix-org/synapse/pull/5321

No known differences from the proposals are included here - alterations are accidental.
 2019-06-05 17:03:19 -06:00
Travis Ralston de725c26cc Add more clarity to the media repo 2019-06-05 10:37:22 -06:00
Travis Ralston aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned 
Fix third party signed definitions for join APIs
 2019-06-05 07:10:19 -06:00
Travis Ralston a3364ff357 Spec SAS verification and the common key verification framework 
Reference implementations:
* 94f664e725
* https://github.com/matrix-org/matrix-react-sdk/pull/2461
* https://github.com/matrix-org/matrix-js-sdk/pull/818
* https://github.com/matrix-org/matrix-react-sdk/pull/2596
* https://github.com/matrix-org/matrix-js-sdk/pull/837

Proposals:
* [MSC1717](https://github.com/matrix-org/matrix-doc/pull/1717)
* [MSC1267](https://github.com/matrix-org/matrix-doc/issues/1267)

No alterations to either proposal have been made intentionally here.
 2019-06-04 12:43:47 -06:00
Travis Ralston 9cb60fa468
Merge pull request #2059 from matrix-org/travis/1.0/msc1719-olm-unwedge 
Add Olm unwedging
 2019-06-04 11:14:54 -06:00