18eca90022
Exclude DEL from historical user IDs
...
The range is inclusive, so don't include 7F
2019-06-12 13:48:50 -06:00
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
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
00fee74636
Update example
2019-06-07 07:40:52 -06:00
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
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
6706d772c9
Fix test vectors with invalid JSON and signature
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2023
The content hashes appear correct, however applying the algorithm defined in the spec never resulted in the signatures previously demonstrated.
2019-05-29 00:46:00 -06:00
40482f7616
Add missing period
2019-05-07 15:55:07 -07:00
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)
2019-04-05 16:24:51 -06:00
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
0ec34039e8
URL encode all the things
2019-03-20 14:44:54 -06:00
42cf72c60f
URL encode matrix.to URIs
2019-03-20 14:43:16 -06:00
e825224b5b
Restrict identifier port numbers to 5 digits.
2019-02-21 21:27:21 +00:00
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
fe7f582233
Fix several spelling mistakes
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2019-02-01 16:43:46 -06:00
166d4ada86
Fix room versions reference in appendices & s2s spec
2019-01-16 17:05:57 -07:00
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
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
6ba50fe2f6
Merge pull request #1588 from matrix-org/rav/fix_server_name
...
Specify that server names cannot be %-encoded
2018-08-30 10:48:06 +01:00
120bb8dc8e
s/host/hostname/
2018-08-29 09:24:24 +01:00
8679a642b4
clarity
2018-08-29 00:19:05 +01:00
7f9524f801
s/--/—/
2018-08-29 00:07:36 +01:00
6f3b42a457
Server names cannot be %-encoded
...
They aren't URLs; it was a thinko to refer to the URL spec for this.
2018-08-28 23:56:20 +01:00
39e674ccb3
Clarify what matrix.to is and mention that room IDs are not routable
...
Also actually render the warning saying that this scheme is temporary.
2018-08-27 18:27:48 -06:00
fa3e9a7609
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills
2018-08-27 18:09:19 -06:00
312799ae78
General clarification for mention and how matrix.to URIs are meant to work
2018-08-25 22:30:49 -06:00
9835c98544
Document how mentions (pills) work
...
Implements the proposal over at https://github.com/matrix-org/matrix-doc/issues/1067
Includes some specification for how matrix.to is structured, and how it is intended to be replaced.
2018-08-21 22:05:47 -06:00
fde48e7ee8
Specify how room versioning works
...
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425
Room version upgrades are not part of MSC1425.
Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions
Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
2018-08-15 15:12:36 -06:00
bdb881420c
Merge branch 'master' into hs/dns-to-be-hostname
2018-07-24 23:12:12 +01:00
26505533dd
drop dns_name = host in favour of host
2018-07-24 16:06:59 +01:00
c3f66e1814
basic spec for group IDs, mostly copied from User IDs as they share grammar
2018-06-11 12:40:04 +01:00
a36f8ba00d
Forbid colons in MXIDs
...
There is a single (AS) user on matrix.org who has a colon in their localpart,
but I suspect that is an artifact of old bridge code and won't work over
federation anyway.
Colons in MXIDs are particularly harmful because they make it impossible to
split mxids into local- and remote-parts
2017-12-18 14:16:25 +00:00
a0455eb5b1
Threat Model: Wrong word: Banning users is a threat only if you're not authorized
...
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
2017-11-20 13:44:10 +01:00
306b3f5d62
Threat Model: Align indentation of Spying Threats.
...
“Disclosure to Servers Within Chatroom” was indented lesser
than the surrounding threats.
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
2017-11-20 13:36:05 +01:00
14df31458b
Attempt to clarify example a little
2017-11-14 15:39:25 +00:00
9c5972ffe3
More formatting / grammar
2017-11-14 15:31:02 +00:00
e12c0b54ff
Formatting & grammar
2017-11-14 15:12:30 +00:00
4526ff2ea6
Double backticks in rst :/
2017-11-14 15:11:30 +00:00
1e4cba6b55
Don't linkify email addresses in examples
2017-11-14 15:10:11 +00:00
3487f5d75a
Spell out what we mean by a 3pid
...
(and consequently rejig all the fixed-width formatting)
2017-11-14 15:08:56 +00:00
6edb90a08e
Document threepids
...
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid
is and how they work.
This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039
with some tweaks and additions.
2017-11-14 14:36:38 +00:00
68e12feec7
Add explicit examples for JSON encoding
2017-11-05 01:14:44 +01:00
628e723483
Move the MXID spec to the appendices
...
Also link to them from the /register API doc.
2017-10-23 00:51:40 +01:00
0a6886e73c
Fix broken link in spec
2017-04-19 16:10:31 +01:00
da686ba4eb
Specification of unpadded Base64
2017-03-01 08:50:07 +00:00
3ee75af06f
Move 'Signing JSON' to appendices
...
Canonical JSON and JSON signing in general are common to the C-S spec. Move
them to the appendices instead of the S-S spec.
2016-10-31 12:36:47 +00:00
a5e12814ef
Split appendices up
...
Split appendices into multiple files
2016-10-31 12:01:37 +00:00
Travis Ralston