Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-04 15:03:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
4076 commits 31 branches 42 tags 32 MiB
Commit graph

1300 commits

Author SHA1 Message Date
Travis Ralston 5eea4a477f Add server notices support 
As per [MSC1452](https://github.com/matrix-org/matrix-doc/issues/1452) 

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

Although MSC1452 focuses on just the warnings part of the server notices, the base for notices has not been established in the spec. This commit adds the needed support to be able to handle notices.

No intentional divergences from the proposal are included in this changeset. There are a few additions which are used in practice although not defined in the proposal, such as who is responsible for aesthetics, sending notices, and other misc rules.
 2019-05-26 20:52:59 -06:00
Travis Ralston 2b96d73305 Fix third party signed definitions for join APIs 
Fixes https://github.com/matrix-org/matrix-doc/issues/1978
 2019-05-26 15:39:35 -06:00
Travis Ralston 5c268ef21f
Merge pull request #2020 from matrix-org/travis/1.0/msc1930-tombstone-notif 
Add a .m.rule.tombstone default push rule for room upgrades
 2019-05-25 09:03:34 -06:00
Travis Ralston ceaccffdf7 Add a .m.rule.tombstone default push rule for room upgrades 
As per [MSC1930](https://github.com/matrix-org/matrix-doc/pull/1930)

There are no known changes to this proposal since it was accepted.
 2019-05-24 17:14:23 -06:00
Travis Ralston 3b0e194ff7 Add version 4 rooms to the spec 
As per [MSC1884](https://github.com/matrix-org/matrix-doc/pull/1884) and [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002).

No known changes since the proposals were accepted.

Due to being in the area: This fixes https://github.com/matrix-org/matrix-doc/issues/1863
 2019-05-24 15:50:05 -06:00
Travis Ralston 3c38956510 Remove prev_content from the redaction essential keys list 
As per [MSC1954](https://github.com/matrix-org/matrix-doc/pull/1954)

No known changes since the proposal was accepted.
 2019-05-24 11:57:22 -06:00
David Baker c38581fb86
Too many spaces 
Co-Authored-By: Travis Ralston <travpc@gmail.com>
 2019-05-14 19:20:01 +01:00
David Baker 383e02835e Words on using m.login.dummy for disambiguation 
Add some text on how m.login.dummy can be used to distinguish
a flow that would otherwise be a subset of other flows.
 2019-05-14 18:07:58 +01:00
Travis Ralston ba18a6e9fa
Merge pull request #1992 from matrix-org/anoa/missing_punctuation3 
Add missing period
 2019-05-07 23:12:47 -06:00
Travis Ralston ce904f9750
Merge pull request #1990 from matrix-org/anoa/missing_punctuation 
Add missing period
 2019-05-07 23:07:07 -06:00
Travis Ralston c54a5fc3df
Merge pull request #1989 from matrix-org/anoa/typo2 
Add missing 'as'
 2019-05-07 23:06:46 -06:00
Andrew Morgan 57cf1aaa96 Add missing period 2019-05-07 19:37:25 -07:00
Andrew Morgan 40482f7616 Add missing period 2019-05-07 15:55:07 -07:00
Andrew Morgan c233535de0 fix typo 2019-05-07 15:51:32 -07:00
Andrew Morgan da82a42308 fix grammatical error 2019-05-07 15:40:39 -07:00
Richard van der Hoff 4e9dc2098f
Fix comments which refer to jenkins. (#1981) 
* Fix comments which refer to jenkins.

* Spelling

Co-Authored-By: turt2live <travpc@gmail.com>
 2019-04-30 17:43:21 +01:00
Travis Ralston 8ad82ce3c0 Add permalink routing through ?via parameters on matrix.to URIs 
Spec for [MSC1704](https://github.com/matrix-org/matrix-doc/pull/1704)

Reference implementations:
* Original: https://github.com/matrix-org/matrix-react-sdk/pull/2250
* Modern recommendations: 2ca281f6b7/src/matrix-to.js (L29-L70)

The only deviation from the original MSC is the recommendation for which servers to pick. The original MSC failed to consider server ACLs and IP addresses correctly, and during implementation it was realized that both of these cases should be handled. The core principles of the original MSC are left unaltered.
 2019-04-05 16:24:51 -06:00
Matthew Hodgson efcbf2f807
Merge branch 'master' into matthew/msc1779 2019-04-03 00:36:23 +01:00
Travis Ralston 1c5ec68cd0
Merge pull request #1876 from matrix-org/travis/v3-id-grammar 
Clarify v3 event representation in identifier grammar
 2019-03-27 08:57:11 -06:00
Hubert Chathi d224c4ff71 fix some errors in key export format 
- empirically, we don't acatually wrap the array in an object
- fix an incorrect type
 2019-03-25 18:57:17 -04:00
Travis Ralston 0ec34039e8 URL encode all the things 2019-03-20 14:44:54 -06:00
Travis Ralston 42cf72c60f URL encode matrix.to URIs 2019-03-20 14:43:16 -06:00
Vikingat-RAGE 76ee13b9bb Fixed bad spacing. 2019-03-18 21:54:56 +00:00
Vikingat-RAGE 1a739ec97b E2E typo fix in spec 2019-03-18 21:16:52 +00:00
Travis Ralston c08d223cfe
Merge pull request #1889 from ma1uta/push_rules 
Fix for the #1865
 2019-02-28 13:31:56 -07:00
Ben Parsons 99405418c9 in the appendices, thanks earfolds 2019-02-26 18:11:02 +00:00
Hristo Venev e825224b5b Restrict identifier port numbers to 5 digits. 2019-02-21 21:27:21 +00:00
Travis Ralston 621437b0c5
Merge pull request #1891 from QMatrixClient/kitsune-drop-obsolete-text 
Remove extended text about life without transaction IDs
 2019-02-21 11:31:55 -07:00
Travis Ralston 49119ed345
Merge pull request #1875 from matrix-org/travis/clarify-upgrades 
Clarify the recommendations for "transferable state"
 2019-02-18 06:14:43 -07:00
Kitsune Ral 989d7ff192 Remove extended text about life without transaction IDs 
Signed-off-by: Kitsune Ral <Kitsune-Ral@users.sf.net>
 2019-02-16 18:49:13 +09:00
Anatoly Sablin befd76f853 Fix links. 2019-02-16 10:38:51 +03:00
Anatoly Sablin 17420c537a Fix links. 2019-02-16 08:56:02 +03:00
Anatoly Sablin 2de7ef9a3d #1865 Add the m.push_rules schema. 2019-02-15 23:23:38 +03:00
Andrew Morgan 48569c2156
Merge pull request #1853 from matrix-org/anoa/3pid_typos 
Replace "3pid" with "3PID"
 2019-02-11 15:11:28 +00:00
Andrew Morgan df7223f992 Add changelogs 2019-02-11 10:02:05 +00:00
Travis Ralston 22188ebfeb Further clarify why membership events are not to be transferred 2019-02-10 19:54:20 -07:00
Travis Ralston 946acbf380 Clarify v3 event representation in identifier grammar 
Fixes https://github.com/matrix-org/matrix-doc/issues/1870
Fixes https://github.com/matrix-org/matrix-doc/issues/1869
Fixes https://github.com/matrix-org/matrix-doc/issues/1867
 2019-02-10 19:49:55 -07:00
Travis Ralston f058a0f40a also power levels 2019-02-10 19:36:33 -07:00
Travis Ralston ef13aef8c3 Clarify the recommendations for "transferable state" 
Fixes https://github.com/matrix-org/matrix-doc/issues/1843
 2019-02-10 19:33:43 -07:00
Travis Ralston 5721712eae Add M_RESOURCE_LIMIT_EXCEEDED 
Original proposal: https://github.com/matrix-org/matrix-doc/issues/1504

No changes from the original proposal or implementations have been made intentionally here.
 2019-02-10 17:47:17 -07:00
Travis Ralston 3e06473305
Merge pull request #1859 from matrix-org/travis/fix-v2-scope 
Change notice about room v2's scope to represent reality
 2019-02-07 11:41:25 -07:00
Travis Ralston 1f05c44a0b
Merge pull request #1860 from matrix-org/travis/fix-spelling-1 
Fix spelling mistake: endponts -> endpoints
 2019-02-07 08:11:43 -07:00
J. Ryan Stinnett 0ed0fee261
Update specification/rooms/v2.rst 
Co-Authored-By: turt2live <travpc@gmail.com>
 2019-02-07 08:09:35 -07:00
Travis Ralston 772ba8dc2a Add a table of contents to each room version spec 
Fixes https://github.com/matrix-org/matrix-doc/issues/1852

We get clickable headers for free by doing this.
 2019-02-06 22:26:41 -07:00
Travis Ralston 85578f9842 Fix spelling mistake: endponts -> endpoints 
Fixes https://github.com/matrix-org/matrix-doc/issues/1677
 2019-02-06 22:19:47 -07:00
Travis Ralston cf11965a8e Change notice about room v2's scope to represent reality 
Fixes https://github.com/matrix-org/matrix-doc/issues/1851
 2019-02-06 22:15:13 -07:00
Travis Ralston 8bd9ca4edd Prep for r0.1.1 of s2s 2019-02-06 12:39:16 -07:00
Travis Ralston bcef94ec70
Merge pull request #1847 from matrix-org/travis/s2s-unstable-warning 
Add the "please use latest.html" warning to the s2s spec
 2019-02-06 08:12:32 -07:00
Andrew Morgan 4ec3a43a85 Replace "3pid" with "3PID" 2019-02-05 12:58:11 +00:00
Travis Ralston 3581368f1f Add the "please use latest.html" warning to the s2s spec 
Now that we have a release, we should be warning people who try and use the unstable spec as fact.
 2019-02-04 14:48:31 -07:00
Travis Ralston e9bac1b011 Remove wrong references to TLS fingerprints 
Also fix some styling in the server discovery section - this didn't feel like it needed its own commit.
 2019-02-04 13:50:17 -07:00
Travis Ralston 1f5783b329 fix links and wording 2019-02-01 18:07:55 -07:00
Travis Ralston 9631e4bcb1 Add a bit of text to ensure that the intro page isn't missed 2019-02-01 18:01:01 -07:00
Travis Ralston 8ace64bab7 r0.1.0 of the s2s specification 2019-02-01 16:10:22 -07:00
Travis Ralston 9364787b9c Remove stability warning 2019-02-01 16:09:48 -07:00
Aaron Raimist fe7f582233
Fix several spelling mistakes 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2019-02-01 16:43:46 -06:00
Travis Ralston d94a70f49d Warn clients about changes in event format 2019-02-01 08:40:18 -07:00
Travis Ralston e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists 
remove references to presence lists
 2019-02-01 08:37:08 -07:00
Travis Ralston 41e50d553e
Merge pull request #1830 from matrix-org/travis/spec/x509-wk 
Specify .well-known s2s discovery and X.509 validation
 2019-02-01 08:36:55 -07:00
Travis Ralston 6421582bf2 Clarifications and alter the error handling of .well-known 
Note that MSC1831 changes the order, so the changes to MSC1708 might not make sense when combining all the proposals together. However, independently the change should make sense.
 2019-02-01 08:18:12 -07:00
Richard van der Hoff 39b71413be
Update specification/server_server_api.rst 
Co-Authored-By: turt2live <travpc@gmail.com>
 2019-02-01 07:40:39 -07:00
Travis Ralston 1c30f5eba9 Clarify certificate usage and ports 2019-01-31 21:15:47 -07:00
Travis Ralston df01acc6e2
Merge pull request #1828 from matrix-org/travis/spec/rooms-v3 
Add specification for room version 3: Event IDs as hashes
 2019-01-31 17:59:31 -07:00
Travis Ralston a6243da03f Wording changes and links 2019-01-31 17:58:42 -07:00
Travis Ralston 48912a7320 Fix auth rules of redactions in v3 2019-01-31 17:35:25 -07:00
Travis Ralston ad64af3f01 Clarify how reference hashes are done 2019-01-31 17:22:55 -07:00
Travis Ralston 01556e5b17 Clarifications and bug fixes in how v3 rooms work 2019-01-31 16:44:37 -07:00
Travis Ralston 3c17a0e53b Mention caching 2019-01-31 16:29:07 -07:00
Travis Ralston b971bcee7d Accurately represent the 3 proposals and provide more detail 2019-01-31 16:24:07 -07:00
Travis Ralston 48e4d6e412 Document domain reuse concerns 
Fixes https://github.com/matrix-org/matrix-doc/issues/1783
 2019-01-31 12:27:09 -07:00
Travis Ralston d2f012f4ea Incorporate MSC1831 
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1831

Implementation proof: pending
 2019-01-31 11:17:56 -07:00
Travis Ralston 0347e873ef Specify .well-known s2s discovery and X.509 validation 
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1708 (note: the JSON requirements were softened by https://github.com/matrix-org/matrix-doc/pull/1824)
* https://github.com/matrix-org/matrix-doc/pull/1711

Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4489
* No explicit PRs for MSC1711 could be found, however Synapse is known to implement it.

There are no intentional changes which differ from the proposals in this commit, however the author has relied upon various historical conversations outside of the proposals to gain the required context. Inaccuracies introduced by the author are purely accidental.
 2019-01-30 22:11:31 -07:00
Travis Ralston ccce6c196d Specify how capabilities work in the c2s API 
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1753
* https://github.com/matrix-org/matrix-doc/pull/1804

Implementation proof:
* https://github.com/matrix-org/synapse/pull/4472
* https://github.com/matrix-org/matrix-js-sdk/pull/830

There is one change to MSC1753 which is included in this commit. MSC1804 remains unchanged. In the original proposal, the change password capability being present was an indication that password changes were possible. It was found that this doesn't really communicate the state very well to clients in that lack of a capability (or a 404, etc) would mean that users would erroneously not be able to change their passwords. A simple boolean flag was added to assist clients in detecting this capability.
 2019-01-30 19:43:55 -07:00
Travis Ralston ff75996524 Add specification for room version 3: Event IDs as hashes 
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1659
Implementation proofs (some traversing of the PR tree may be required to get all of them):
* https://github.com/matrix-org/synapse/pull/4483
* https://github.com/matrix-org/synapse/pull/4499

This doesn't intentionally change anything from the proposal.

**Implementation details**:

The simple part of this is the introduction of a rooms/v3.html document. The somewhat unclear part is the stuff done to the s2s definitions. This pulls `unsigned_pdu` out to `unsigned_pdu_base` (all fields except `event_id`) where it can be reused in `pdu` and `pdu_v3` (for rooms v3). These definitions are further moved into the room version specifications where they can highlight the exact schemas in detail.

Version 1 has been updated to include the pre-existing event format, however the core principles of the room have not been changed. The same applies to room version 2. Room versions have immutable core principles once in the spec, otherwise these format changes would land in a pre-existing version.

The client-server API event formats will need updating, however that is being punted to a different commit to try and keep these changes reviewable.
 2019-01-30 17:03:03 -07:00
Neil Johnson c09fa6845e
Update presence.rst 2019-01-29 18:23:30 +00:00
Travis Ralston 00adfdbf4a
Merge pull request #1820 from matrix-org/travis/spec/fed-v2-invite 
Specification for v2 s2s invite API
 2019-01-29 09:12:21 -07:00
Andrew Morgan 0712fd36a2 75% majority now required for FCP 2019-01-29 14:36:26 +00:00
Travis Ralston aca9437bf3 Specification for v2 s2s invite API 
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1794
Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4402
* https://github.com/matrix-org/synapse/pull/4496

There are no changes from the original proposal.
 2019-01-28 21:07:00 -07:00
Neil Johnson bf2b6e6daa remove references to presence lists 2019-01-28 15:05:10 +00:00
Matthew Hodgson a358e2d4d8 rst 2019-01-28 14:58:17 +00:00
Richard van der Hoff 9f443225ac fix incorrect spelling of homeserver 2019-01-26 20:10:32 +00:00
Travis Ralston 6c7eea555a
Merge pull request #1773 from matrix-org/travis/spec/rooms 
Add a room version specification
 2019-01-24 09:47:33 -07:00
Travis Ralston 052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades 
Add room version upgrades
 2019-01-23 19:04:24 -07:00
Travis Ralston 061f59547a Minor wording changes 2019-01-23 09:10:14 -07:00
Hubert Chathi 5cafcd103f
Fix copyright 
> Since this is a copy-and-paste of old text, I think the copyright year should match when the original text was written, which according to git was 2017.

Co-Authored-By: turt2live <travpc@gmail.com>
 2019-01-22 21:43:32 -07:00
Travis Ralston 0dfc64a9f4 Improve wording 2019-01-22 18:11:36 -07:00
Travis Ralston bd5e760a0d Simplify the description for room versions 
Instead of trying to describe maturity, stability, and recommendedness in one list we should describe what is "safe" and "unsafe" to use. The default version is just something that servers should use, and is normally going to be stable.
 2019-01-22 18:02:21 -07:00
Hubert Chathi ebe887d931
Grammar 
Co-Authored-By: turt2live <travpc@gmail.com>
 2019-01-18 09:56:04 -07:00
Matthew Hodgson 86703ef952
Merge branch 'master' into matthew/msc1779 2019-01-17 23:57:48 +00:00
Matthew Hodgson 3b86fa0e3c incorporating delph & vdh reviews 2019-01-17 23:56:49 +00:00
Travis Ralston ba37f2d311 prompt->advertise 2019-01-17 16:19:25 -07:00
Travis Ralston 19e94815f9 Try and improve the understanding of room versions 2019-01-17 15:13:01 -07:00
Travis Ralston 0dde2489b6 Clarify what a Mandatory room version is 2019-01-17 14:48:42 -07:00
Travis Ralston 96d754f429 promote -> prompt 2019-01-17 14:43:11 -07:00
Travis Ralston a6f5d01586 Clarify that servers don't have to implement development/beta versions 2019-01-17 14:39:06 -07:00
Travis Ralston 2457438f1e Encourage servers to transfer whatever they can while being open-ended 2019-01-17 13:57:02 -07:00
Travis Ralston 4e0533a5f3 Soften UX requirements 2019-01-17 13:56:48 -07:00
Travis Ralston fcc26d247e
Merge pull request #1789 from matrix-org/travis/spec/sso-login 
Add a generic SSO login API
 2019-01-17 11:20:18 -07:00
Travis Ralston 82ee3a6035 Adjust wording for SSO introduction 2019-01-17 11:18:48 -07:00
Travis Ralston 166d4ada86 Fix room versions reference in appendices & s2s spec 2019-01-16 17:05:57 -07:00