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
4155 commits 31 branches 42 tags 32 MiB
Commit graph

53 commits

Author SHA1 Message Date
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 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 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 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 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 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 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
Ben Parsons 99405418c9 in the appendices, thanks earfolds 2019-02-26 18:11:02 +00: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
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 01556e5b17 Clarifications and bug fixes in how v3 rooms work 2019-01-31 16:44:37 -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
Richard van der Hoff 9f443225ac fix incorrect spelling of homeserver 2019-01-26 20:10:32 +00:00
Travis Ralston 061f59547a Minor wording changes 2019-01-23 09:10:14 -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
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 71e6321f4d Rework how room versions are represented 
Versions are actually on a scale of recommendations, and are expected to be created as needed. The scale presented here (develop/beta/default/recommended/mandatory) is a more wordy version of what was previously discussed/intended for room versions - the labels aren't final and may be changed.
 2019-01-16 16:57:45 -07:00
Ben Parsons 16f17855c9 link to CS API Swagger Viewer 2018-12-05 15:47:55 +00: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
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
Ben Parsons e7c79f2bd4 avoid .rst link conflict warnings 2018-07-20 15:30:58 +01:00
Ben Parsons 54d6d58fff naively move content from intro.rst to index.rst 2018-07-20 14:15:47 +01:00
Ben Parsons 8d550d2166 force re-render 2018-05-23 09:39:18 +01:00
Ben Parsons 0b776b0e9c link to proposals page from index 2018-05-21 11:01:03 +01:00
Richard van der Hoff c08e6616c7 Try to make the intro link more obvious 
Fixes https://github.com/matrix-org/matrix-doc/issues/1031.
 2017-10-23 00:51:41 +01:00
Richard van der Hoff 49cd65dd58 Add a license to the spec 
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
 2016-07-12 17:28:30 +01:00
Richard van der Hoff 351bbee016 Remove changelog from index.rst 
... since it's explicitly unversioned.
 2016-05-05 15:23:21 +01:00
Richard van der Hoff 5b010de2b3 Fix typo 2016-05-05 15:15:39 +01:00
Richard van der Hoff e68193d2e0 Attempt to clarify the spec versioning. Again. 2016-05-05 15:03:04 +01:00
Matthew Hodgson 17b8fccd4c rephrase intro 2016-05-05 14:00:53 +01:00
Jimmy Cuadra c44d61b3a9 Clarify which documents are generated from scripts. 2016-05-04 02:30:44 -07:00
Jimmy Cuadra 22b542e3f9 Fix grammar in spec index. 2016-05-04 02:27:29 -07:00
Jimmy Cuadra 5b18db9096 Make list of APIs on the index a table. 2016-05-04 01:42:01 -07:00
Jimmy Cuadra 4b27d6a7a4 Reorganize spec index. 2016-05-04 01:42:01 -07:00
David Baker 71cb646541 Change id in the push gateway poke to be event_id and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 2016-04-06 18:28:21 +01:00
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec 
More to come
 2016-03-09 15:49:23 +00:00
Richard van der Hoff 91fa78eb53 Start development on next spec version 2016-01-11 15:52:08 +00:00
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 2016-01-06 17:43:20 +00:00
Daniel Wagner-Hall 7f87760655 Add links to old releases 2015-12-09 16:45:56 +00:00
Daniel Wagner-Hall 8d184570a8 Mention intro before specs 2015-12-09 16:40:47 +00:00
Daniel Wagner-Hall 997f3303f3 Revert "Add links to old releases" 
This reverts commit de12870791.
 2015-12-09 16:38:40 +00:00