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

1191 commits

Author SHA1 Message Date
Travis Ralston 3e7a5f5ea4 Initial draft for SSO support 2019-01-09 00:09:38 -07:00
Travis Ralston bc1303a1a0
Add a bit of rationale for WIP tags 2019-01-07 13:39:50 -07:00
Travis Ralston 671527360c
Recommend some kind of WIP tag for MSCs 2019-01-07 13:16:45 -07:00
Travis Ralston 258aba5fed Incorporate MSC1693 
This is largely blatant copy/paste from the MSC with some formatting done to tidy it up a bit.
 2019-01-07 13:09:21 -07:00
Travis Ralston ffe577371d Add a room version specification 
The "Room Specification" (or "Room Version Specification") is the specification that defines which room versions do what and are intended to be documents which speak the truth about how rooms operate under the hood.

The approach taken here is a bit different than other specifications. For starters, the specification is versioned in this project instead of relying on the matrix.org repository to track compiled HTML. This is done for a couple reasons, the first being we're still developing the v1 specification while concurrently making a v2 spec and the second being trying to reduce the reliance on matrix.org's repository for specifications.

Because the room spec is built into versions, some changes needed to be made. The `targets.yaml` now has a special syntax for indicating what version something is at, and the changelog generator can handle rendering different versions of the same changelog (as parsed from the RST). Some additional work has been put in to the changelog parsing to allow us to reference the v1 room spec as "v1" without having to sacrifice clarity in the changelog headings.

Finally, this moves the state resolution algorithms into the versioned
spec as a result of MSC1759 (https://github.com/matrix-org/matrix-doc/pull/1759).

Note: this does not introduce the concept of versioned schemas (tabs) that I was previously working with. There's currently no use for them, so they are shelved elsewhere.
 2019-01-04 15:49:24 -07:00
Richard van der Hoff 958b956776
Merge pull request #1755 from matrix-org/erikj/event_checks 
Document the checks made for incoming PDUs
 2018-12-18 15:08:58 +01:00
Travis Ralston 35de43de61
Merge pull request #1743 from matrix-org/dbkr/add_sandbox_to_csp 
Add 'sandbox' to recommended CSP header
 2018-12-17 10:28:06 -07:00
Erik Johnston 39df8291e9 Add TODO 2018-12-14 13:23:18 +00:00
Erik Johnston be625254b1 Fix up wording about auth rules to not lie 2018-12-14 13:23:18 +00:00
Erik Johnston c93bdcc59c Fix up headings 2018-12-14 13:23:18 +00:00
Richard van der Hoff cac150d567
Fix up wording 
Co-Authored-By: erikjohnston <erikj@jki.re>
 2018-12-14 13:13:06 +00:00
Erik Johnston ee9c010c37 Document the checks made for incoming PDUs 2018-12-13 14:15:25 +00:00
Richard van der Hoff fa0b4f9e13 Make the proposal labels match what happens in practice 2018-12-13 11:14:21 +00:00
J. Ryan Stinnett d197a5761f Clarify encrypted push rules 
Fix `.m.rule.encrypted_room_one_to_one` by moving a condition to the right block
of the rule.

Fix `.m.rule.encrypted` to state that it applies to group rooms.

Signed-off-by: J. Ryan Stinnett <jryans@gmail.com>
 2018-12-11 16:07:01 +00:00
David Baker e318286404 Add 'sandbox' to recommended CSP header 2018-12-10 17:33:04 +00:00
Ben Parsons 16f17855c9 link to CS API Swagger Viewer 2018-12-05 15:47:55 +00:00
Ben Parsons 43109a717f placeholder for proposals CSS 2018-12-03 12:27:58 +00:00
Richard van der Hoff 767af87744
Merge pull request #1701 from uhoreg/e2e_export 
document megolm session export format
 2018-11-06 11:58:00 +00:00
Hubert Chathi 189725659a clarifications and formatting fixes 2018-11-05 15:43:18 -05:00
Matthew Hodgson 179162379e spell out that shepherd cannot be author 2018-10-27 19:34:52 +01:00
Erik Johnston 4271391214
Initial stab at documenting soft fail (#1641) 2018-10-26 15:18:04 +01:00
Andrew Morgan f288facec8
Merge pull request #1697 from matrix-org/anoa/msc_update 
The new and improved MSC process
 2018-10-23 20:02:36 +02:00
Andrew Morgan f8ffa79b56 Update and clarify proposal labels 2018-10-23 19:37:51 +02:00
Andrew Morgan 2b259c6a7b Remove etiquette page from targets 2018-10-21 00:54:04 +02:00
Andrew Morgan 4b858a7993 DCO required for proposal and spec PR 2018-10-21 00:52:39 +02:00
Andrew Morgan 0afb122760 Clarification on FCPs 2018-10-20 23:50:26 +02:00
Andrew Morgan f00be6b0d8 Etiquette -> guiding principles 2018-10-20 23:35:33 +02:00
Hubert Chathi 46fde9723c document megolm session export format 2018-10-19 10:55:14 -04:00
Matthew Hodgson c6e0a88b09 fix irc bridge example properly 2018-10-18 21:50:39 +01:00
Matthew Hodgson 7a86bc4a66 fix missing escapes on AS regexp 2018-10-18 21:48:14 +01:00
Andrew Morgan ea21e31a0c Merge branch 'anoa/msc_update' of github.com:matrix-org/matrix-doc into anoa/msc_update 2018-10-18 16:03:14 +02:00
Andrew Morgan 7bff4d288c be begin -> begin 2018-10-18 15:52:28 +02:00
Travis Ralston 5a2d28e7fd Reduce more abbreviations! 2018-10-17 18:21:16 +02:00
Travis Ralston 9625f11fd4 reduce abbreviations 2018-10-17 18:20:42 +02:00
Andrew Morgan d487c0974f Clarify how to get a shepherd (just ask) 2018-10-17 17:17:07 +02:00
Andrew Morgan 45c935d8d3 Clarify that MSCs aren't just issues anymore. 2018-10-17 15:35:15 +02:00
Andrew Morgan 1e939c50f5 Gather feedback 2018-10-17 14:49:01 +02:00
Andrew Morgan 148f7d7b33 Minor proposal updates are allowed 2018-10-17 14:34:57 +02:00
Andrew Morgan 5a1e735921 Fix sign off bullet 2018-10-16 01:21:14 +02:00
Andrew Morgan aeea060bb8 Specify where to find the MSC ID 2018-10-16 01:06:44 +02:00
Andrew Morgan 7753957d04 remove ambiguity 2018-10-16 01:04:54 +02:00
Andrew Morgan 2f0025c7a7 Fix up wording in proposal etiquette 2018-10-16 00:57:11 +02:00
Andrew Morgan 35c924308c core team -> Core Team 2018-10-16 00:57:08 +02:00
Andrew Morgan 8121bef771 Introduce the spec core team 2018-10-16 00:44:05 +02:00
Andrew Morgan c1ecb9e324 Fix up table with title and add corresponding GitHub labels 2018-10-16 00:17:08 +02:00
Andrew Morgan 889b46898c Move proposal etiquette to a separate document. 2018-10-16 00:07:16 +02:00
Andrew Morgan 49d017bdd5 your proposal -> the proposal 2018-10-15 23:51:28 +02:00
Andrew Morgan fb4c50ec8a No need to redefine MSC 2018-10-15 23:37:41 +02:00
Andrew Morgan 604091380f Attempt to fix contributing link 2018-10-15 16:41:44 +02:00
Andrew Morgan b3f90f5825 proposal passed = spec pr missing 2018-10-15 16:38:48 +02:00
Andrew Morgan 873641e4bc Proposal Created and In Review is a single phase 2018-10-15 16:34:41 +02:00
Andrew Morgan 11dbd5b56a Proposal WIP -> drafting/feedback gathering 2018-10-15 16:30:33 +02:00
Andrew Morgan 5ae3b50c6b Require link to implementation 2018-10-15 16:18:20 +02:00
Andrew Morgan f1d71bd6c4 Less complicated wording 2018-10-15 16:09:04 +02:00
Andrew Morgan 0e9ad9e95d Fix wording, fix earlier capatilization 2018-10-15 16:05:09 +02:00
Andrew Morgan f769084570 Put it in the proposals dir! 2018-10-15 15:54:28 +02:00
Andrew Morgan 67146e4bec MSC ALL the changes 2018-10-15 15:52:33 +02:00
Andrew Morgan 9432ed76d7 first-draft -> first draft 2018-10-15 15:51:54 +02:00
Andrew Morgan 80d1d4af9c Fix capatilization 2018-10-15 15:48:55 +02:00
Andrew Morgan d2e827e0c6 Note about earlier MSC process 2018-10-15 15:46:26 +02:00
Andrew Morgan 764c63f3e8 Add proposal template 2018-10-15 15:29:40 +02:00
Andrew Morgan a3144e6959 Move to the new and improved MSC process 2018-10-15 02:33:15 +02:00
Matthew Hodgson 6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update 
document device list synchronisation over federation.
 2018-09-03 16:54:36 +01:00
Matthew Hodgson 334c69bcda wording fix 2018-09-03 16:53:39 +01:00
Matthew Hodgson ccbc88ee5d reword to spell out to when device list updates should be sent 2018-09-03 16:49:36 +01:00
Matthew Hodgson bcd48ebbec
Merge pull request #1610 from uhoreg/reloaded 
document new state resolution algorithm
 2018-09-02 23:53:08 +01:00
Konstantinos Sideris 192a6c2ab9 Use example.org on examples instead of domain.com which is a real domain 
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
 2018-09-02 17:58:21 +03:00
Matthew Hodgson e9e3afbd34 clarify who servers should send m.device_list_update EDUs to 2018-09-02 13:00:29 +01:00
Matthew Hodgson 928fc5cbe5 incorporate review 2018-09-01 03:08:53 +01:00
Matthew Hodgson 42b11e096f Review 2018-09-01 02:48:37 +01:00
Matthew Hodgson d25f4412d4 improve wording 2018-09-01 02:46:05 +01:00
Matthew Hodgson db302b66ca revert example which was corect first time; fix rst 2018-09-01 02:44:53 +01:00
Matthew Hodgson 0f9a23c471 swaggerify to-device 2018-09-01 02:37:31 +01:00
Matthew Hodgson 0afdcc59ea spell out stream_id and fix todo 2018-09-01 02:10:45 +01:00
Matthew Hodgson 30d56691b1 document device list synchronisation over federation. 
untested
closes MSC1212
 2018-09-01 01:48:02 +01:00
Travis Ralston 735de03e07 Add r0 version links 
These were missed in the release process.
 2018-08-31 17:40:32 -06:00
Travis Ralston bb2835651f
Merge pull request #1637 from turt2live/travis/c2s/clarify-errors 
List known client-server error codes; Clarify priority of error codes vs http status code
 2018-08-31 16:42:43 -06:00
Travis Ralston 00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar 
Spec grammars for IS things
 2018-08-31 16:05:23 -06:00
Travis Ralston f3825c5827 A couple more stragglers 2018-08-31 15:55:07 -06:00
Travis Ralston 218b86d6e8 Hopefully the last one 2018-08-31 15:48:41 -06:00
Richard van der Hoff 79974b152c s/identity service/identity server 2018-08-31 22:44:36 +01:00
Richard van der Hoff a544b68298 Merge branch 'master' into rav/is_token_grammar 2018-08-31 22:37:04 +01:00
Travis Ralston 7d34995ece It's actually an "identity server implementing the Identity Service API" 
Also add a note about appservices being special.
 2018-08-31 15:35:32 -06:00
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 2018-08-31 15:04:00 -06:00
Travis Ralston ec248b436f Identity Service is lowercase 2018-08-31 15:04:00 -06:00
Travis Ralston cc0badaaa1 Fix all naming cases of "identity service" 
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
 2018-08-31 15:04:00 -06:00
Travis Ralston 108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers 
Add read markers
 2018-08-31 14:47:39 -06:00
Travis Ralston 835f5de387 Generalize the token name even more 2018-08-31 14:22:07 -06:00
Richard van der Hoff dced3d5707 Notes on the format of IS session IDs and tokens 2018-08-31 21:06:51 +01:00
Travis Ralston f299fe023a English 2018-08-31 12:51:31 -06:00
Travis Ralston f4c5c209f3 Generalize language for pagination 
Previously the section was very strict in what pagination was, however this isn't the reality for the matrix specification. Several endpoints have their own pagination naming conventions and do not follow those mandated by this section.

This commit generalizes the language to cover those endpoints while also describing how pagination works. In particular, it describes the rough API shape to expect and how to deal with the responses.

This commit also removes the `M_BAD_PAGINATION` error as it is not used in the real world. Homeservers are instead encouraged to use the standard `M_INVALID_PARAM` or similar error code.

Fixes https://github.com/matrix-org/matrix-doc/issues/610
Fixes https://github.com/matrix-org/matrix-doc/issues/1523
 2018-08-31 12:36:08 -06:00
Hubert Chathi c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach 
Document encrypted attachments
 2018-08-31 13:33:05 -04:00
Travis Ralston 4b9fb99644 Take out unhelpful example 2018-08-31 11:18:54 -06:00
Travis Ralston 3146fc339a Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-errors 2018-08-31 11:15:03 -06:00
Travis Ralston f6d9e53f5c Clarify that homeserver must reject clients from setting m.fully_read 2018-08-31 11:13:32 -06:00
Travis Ralston 2e8151999e Clarify that read markers are fully read markers 2018-08-31 11:13:19 -06:00
Hubert Chathi f1f32d3a15 add more clarifications 2018-08-31 12:59:57 -04:00
Travis Ralston 679ddabb53 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers 2018-08-31 10:34:19 -06:00
Travis Ralston 567843e043 Add additional clarity to how rich replies are structured and used 2018-08-31 10:20:26 -06:00
Hubert Chathi e3daf10bb9 refactor encrypted file schema as "Extension to m.message" 2018-08-31 12:11:27 -04:00