Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-20 16:38:37 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
6993 commits 29 branches 42 tags 32 MiB
Commit graph

492 commits

Author SHA1 Message Date
Jonas Platte 6e78cde3eb
Fix wrong matrix.to URL in spec appendices (#3409) 2021-09-23 10:39:47 -06:00
Denis Kasak ed08c1cb9e Tweak PDU diagram demonstrating prev_events. (#3340) 
This tweaks the DAG to be simpler, with two linear event chains E4 -> E3
-> E2 -> E1 and E6 -> E5 -> E2 -> E1. The extremities of the DAG are now
the first and only point in the DAG where multiple event parents occur.
Since the point of the diagram is to demonstrate this very situation,
it's better didactically if there is only one such situation in the
diagram.
 2021-08-31 16:51:06 +01:00
Richard van der Hoff f8b83b7fb1 Replace "Pagination" section in C-S API with text in appendices (#3366) 
The Pagination section in the C-S API was, basically, full of rubbish. I think that anything of any value it contained was repeated either directly on the API definitions or in the text specific to syncing at https://spec.matrix.org/unstable/client-server-api/#syncing.

The conventions I've added to the Appendices are based on the discussions in #1898. They are there because I don't want to have to go through it all again next time we add a paginated API.

Fixes: #1898
Fixes: #2268
 2021-08-27 19:17:18 +01:00
Neil Alexander 3d278b891d Add clarification on binary data and base64 encoding to Appendices (#3362) 
* Add clarification on binary data and base64 encoding (closes #3341)

* Add changelog fragment

* Delete 3362.clarification
 2021-08-27 19:17:18 +01:00
ColonisationCaptain 7c58999c6a Insert missing space 
Insert missing space
 2021-08-27 19:17:18 +01:00
Richard van der Hoff 4b2bbbabcc Start a 'conventions' section in the Appendices (#3350) 
I wanted a section for "here's what new APIs ought to do", which isn't really
very useful for consumers of the existing APIs.
 2021-08-27 19:17:18 +01:00
Niels Basjes cf5b519963 Explain the reasons why <hostname> TLS certificate is needed rather than <delegated_hostname> for SRV delegation. (#3322) 
Signed-off-by: Niels Basjes <niels@basjes.nl>
 2021-08-27 19:17:17 +01:00
Travis Ralston f433e07763 Merge pull request #3225 from sideshowbarker/client-server-api-Access-Control-Allow-Headers-drop-Options-Accept 
Drop Origin & Accept from Access-Control-Allow-Headers value
 2021-08-27 19:17:15 +01:00
Michael[tm] Smith d7cf63d981 Drop Origin & Accept from Access-Control-Allow-Headers value 
This change drops the Origin and Accept header names from the
recommended value for the CORS Access-Control-Allow-Headers header. Per
the CORS protocol, it’s not necessary or useful to include them.

Per-spec at https://fetch.spec.whatwg.org/#forbidden-header-name, Origin
is a “forbidden header name” set by the browser and that frontend
JavaScript code is never allowed to set.

So the value of Access-Control-Allow-Headers isn’t relevant to Origin or
in general to other headers set by the browser itself — the browser
never ever consults the Access-Control-Allow-Headers value to confirm
that it’s OK for the request to include an Origin header.

And per-spec at https://fetch.spec.whatwg.org/#cors-safelisted-request-header,
Accept is a “CORS-safelisted request-header”, which means that browsers
allow requests to contain the Accept header regardless of whether the
Access-Control-Allow-Headers value contains "Accept".

So it’s unnecessary for the Access-Control-Allow-Headers to explicitly
include Accept. Browsers will not perform a CORS preflight for requests
containing an Accept request header.

Related: Related: https://github.com/matrix-org/synapse/pull/10114

Signed-off-by: Michael[tm] Smith <mike@w3.org>
 2021-08-27 19:17:15 +01:00
ilovecommits 175e3c157d Correct 'once-off' to 'one-off' 2021-08-27 19:17:15 +01:00
Travis Ralston 30654f70ee Merge pull request #3176 from matrix-org/travis/clarification/lowercasing 
Case fold instead of lowercase
 2021-08-27 19:17:14 +01:00
Hubert Chathi 221375b105 Merge pull request #3207 from toadjaune/patch-2 
Fix a typo in event soft rejection schema
 2021-08-27 19:17:14 +01:00
Travis Ralston 8b40972872 iterate 2021-08-27 19:17:14 +01:00
Hubert Chathi 586c4d865a Fix broken ASCII art 2021-08-27 19:17:14 +01:00
Travis Ralston 21a132d3a5 Merge branch 'master' into travis/clarification/lowercasing 2021-08-27 19:17:14 +01:00
Hubert Chathi f9c9fce1ad Deprecate verifications that don't begin with a request. 2021-08-27 19:17:14 +01:00
Arnaud Venturi 0d275cc739 Fix a typo in event soft rejection schema 
Signed-off-by: Arnaud Venturi <github@toadjaune.eu>
 2021-08-27 19:17:14 +01:00
Travis Ralston 4cb667ca27 Case fold instead of lowercase 
Fixes https://github.com/matrix-org/matrix-doc/issues/3175
 2021-08-27 19:17:14 +01:00
Andrew Morgan fca6992cd9 Clarify that implementations can use stable prefixes once an MSC has merged (#3179) 
Fixes #3146.

This PR changes the Matrix Spec Proposals page to clarify that implementations **do not** need to wait until a spec release to use stable prefixes, but that they can do so after the corresponding MSC has been merged. The justification is that once an MSC has been merged, it's fairly guaranteed that it will land in the spec. Yet it will take time for the spec release process to run its course, and we shouldn't make implementations wait for that.

The exception to this is if implementating a feature in a backwards-compatible way requires a new spec version to indicate to clients/servers that a feature has been added/changed. This situation is rare though, and most implementations won't fall into this category.
 2021-08-27 19:17:14 +01:00
Andrew Morgan 5d0d5a3981 Clarify what happens when a concern is raised during FCP (#3180) 
It wasn't entirely clear what should happen to the FCP timer (and state) when a concern is raised during FCP. After some discussion, we agreed that when a concern is raised:

1. FCP will continue to not conclude until at least 5 days have passed, but once those 5 days are up it *still* won't conclude until all concerns raised during FCP are resolved.
2. If a concern warrants a large enough change in the document, then the Spec Core Team may consider cancelling FCP and restarting the timer in order for people to have some time to think about and review the new changes.
 2021-08-27 19:17:14 +01:00
Travis Ralston a5fea91d86 Merge pull request #3177 from matrix-org/travis/spec/spaces-groups-rm 
Remove group identifiers
 2021-08-27 19:17:14 +01:00
Travis Ralston 3d217e0de0 Merge pull request #3101 from matrix-org/travis/spec/MSC2320-identity-versions 
Add identity service versions API
 2021-08-27 19:17:13 +01:00
Travis Ralston 3c01fa4681 Remove group identifiers 
Groups are replaced by https://github.com/matrix-org/matrix-doc/pull/1772 and this probably shouldn't have made it into the spec in the first place without the remaining context of Groups.
 2021-08-27 19:17:13 +01:00
Travis Ralston c11efb35fe Merge pull request #3163 from matrix-org/travis/spec/msc2858-multisso 
Describe social-sign-on (multiple SSO providers)
 2021-08-27 19:17:13 +01:00
Travis Ralston fb3dde1c2c Merge pull request #3167 from matrix-org/travis/spec/msc2265-lower-3pid 
Specify that email handling converts to lowercase first
 2021-08-27 19:17:13 +01:00
Travis Ralston 466911b253 Merge pull request #3170 from matrix-org/travis/spec/msc2713-rm-v1-id 
Remove v1 identity service API
 2021-08-27 19:17:13 +01:00
Travis Ralston 2c3d7b1682 Apply suggestions from code review 
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
 2021-08-27 19:17:12 +01:00
Travis Ralston 53833d49a5 Spelling 2021-08-27 19:17:12 +01:00
Travis Ralston 37c3a3f855 Remove v1 identity service API 
Spec for https://github.com/matrix-org/matrix-doc/pull/2713
 2021-08-27 19:17:12 +01:00
Travis Ralston 49a5ca3553 Downgrade identity server failure to FAIL_PROMPT instead of FAIL_ERROR 
Spec for https://github.com/matrix-org/matrix-doc/pull/2284
 2021-08-27 19:17:12 +01:00
Travis Ralston fc6aa30000 Merge branch 'master' into travis/spec/MSC2320-identity-versions 2021-08-27 19:17:12 +01:00
Travis Ralston 3aa517a868 Clarify provider naming 2021-08-27 19:17:12 +01:00
Travis Ralston 7cef7d0fcf Specify that email handling converts to lowercase first 
Spec for https://github.com/matrix-org/matrix-doc/pull/2265
 2021-08-27 19:17:12 +01:00
Travis Ralston 457f3995af Merge pull request #3154 from matrix-org/travis/spec/knock-knock-whos-there 
Add knocking to the spec
 2021-08-27 19:17:12 +01:00
Travis Ralston cbd761df17 Apply suggestions from code review 
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
 2021-08-27 19:17:12 +01:00
Hubert Chathi ec9ea2b6e3 Merge pull request #3149 from uhoreg/qr_codes_spec 
Add spec for verification by QR codes.
 2021-08-27 19:17:12 +01:00
Travis Ralston be86e638c5 Add identity service versions API 
Specs [MSC2320](https://github.com/matrix-org/matrix-doc/pull/2320)
Built upon https://github.com/matrix-org/matrix-doc/pull/3094
 2021-08-27 19:17:12 +01:00
Hubert Chathi e9e0d8ee47 Merge pull request #3151 from uhoreg/single_ssss_spec 
Document Single SSSS.
 2021-08-27 19:17:12 +01:00
Travis Ralston 57f4347b5d Fix general wording 2021-08-27 19:17:12 +01:00
Hubert Chathi 3084f3d32f Merge pull request #3150 from uhoreg/verification_fixes 
Make SAS outline fit with key verification in DM flow.
 2021-08-27 19:17:12 +01:00
Travis Ralston 3b426846fe Describe social-sign-on (multiple SSO providers) 
Spec for [MSC2858](https://github.com/matrix-org/matrix-doc/pull/2858)
 2021-08-27 19:17:12 +01:00
Travis Ralston fa6cc8a1ff Add knocking to the spec 
Spec for https://github.com/matrix-org/matrix-doc/pull/2998
Spec for https://github.com/matrix-org/matrix-doc/pull/2403

This deliberately does not help towards fixing https://github.com/matrix-org/matrix-doc/issues/3153 in order to remain consistent with prior room versions, and to keep the diff smaller on this change. A future change will address room version legibility.
 2021-08-27 19:17:12 +01:00
Hubert Chathi 1a1f01234d Apply suggestions from code review 
Co-authored-by: Travis Ralston <travpc@gmail.com>
 2021-08-27 19:17:11 +01:00
Hubert Chathi 7a960375cc Update content/client-server-api/modules/end_to_end_encryption.md 
Co-authored-by: Travis Ralston <travpc@gmail.com>
 2021-08-27 19:17:11 +01:00
Hubert Chathi ca37ada9e2 Document Single SSSS. 2021-08-27 19:17:11 +01:00
Hubert Chathi bb06dbdb2a Add information about using SSSS for cross-signing and key backup. 2021-08-27 19:17:11 +01:00
Hubert Chathi f9dce3dfed Add spec for verification by QR codes. 2021-08-27 19:17:11 +01:00
Hubert Chathi fd5da297d8 Make SAS outline fit with key verification in DM flow. 2021-08-27 19:17:11 +01:00
Hubert Chathi 1638d2f32e Apply suggestions from code review 
Co-authored-by: Travis Ralston <travpc@gmail.com>
 2021-08-27 19:17:11 +01:00
Hubert Chathi b5bdfffa53 spec verification in DMs and m.key.verification.ready/done 2021-08-27 19:17:11 +01:00
Travis Ralston a855ed338b Fix event size restriction (#3127) 
Fixes https://github.com/matrix-org/matrix-doc/issues/3126
 2021-08-27 19:17:10 +01:00
Travis Ralston d0d6b77053 Merge pull request #3099 from matrix-org/travis/spec/MSC2801-untrusted-bodies 
Sprinkle some DANGER: UNSAFE warnings over the spec about event bodies
 2021-08-27 19:17:10 +01:00
Travis Ralston 208a0806dd Merge pull request #3098 from matrix-org/travis/spec/r2-MSC2010-MSC2422-MSC2557-color-spoilers 
Incorporate spoilers and `color` tag allowance
 2021-08-27 19:17:10 +01:00
Travis Ralston 5d2cb50c58 Apply suggestions from code review 
Co-authored-by: Matthew Hodgson <matthew@matrix.org>
 2021-08-27 19:17:10 +01:00
Travis Ralston a0345ea0bb Incorporate spoilers and color tag allowance 
Specs [MSC2010](https://github.com/matrix-org/matrix-doc/pull/2010)
Specs [MSC2557](https://github.com/matrix-org/matrix-doc/pull/2557)
Specs [MSC2422](https://github.com/matrix-org/matrix-doc/pull/2422)
Obsoletes https://github.com/matrix-org/matrix-doc/pull/2549
Built upon https://github.com/matrix-org/matrix-doc/pull/3094
 2021-08-27 19:17:10 +01:00
Travis Ralston 30f37f1e66 Sprinkle some DANGER: UNSAFE warnings over the spec about event bodies 
Specs [MSC2801](https://github.com/matrix-org/matrix-doc/pull/2801)
Based on https://github.com/matrix-org/matrix-doc/pull/3094
 2021-08-27 19:17:10 +01:00
Travis Ralston 228fcb8175 Allow <details> and <summary> in suggested HTML subset 
Specs [MSC2184](https://github.com/matrix-org/matrix-doc/pull/2184)
Based on https://github.com/matrix-org/matrix-doc/pull/3094
 2021-08-27 19:17:10 +01:00
wbamberg 54a4f689a0 Merge pull request #3002 from wbamberg/fix-h7-h8 
Remove h7 and h8 headings
 2021-08-27 19:16:42 +01:00
wbamberg 1bfc3de6d6 Merge pull request #2992 from wbamberg/support-changelogs 
Support changelogs
 2021-08-27 19:16:42 +01:00
wbamberg 94f6cd21e3 Clarify the current situation wrt key derivation algorithms 
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
 2021-08-27 19:16:42 +01:00
Will a974bdaf45 Remove h7 and h8 headings 2021-08-27 19:16:42 +01:00
Will 643cdd19c8 Support rendering of proposal tables 2021-08-27 19:16:42 +01:00
Will 3e03e7b17a A few small fixes in /data and /content 2021-08-27 19:16:42 +01:00
Will 9a179038cc Fix links to rendered APIs 2021-08-27 19:16:42 +01:00
Will 72ff5b92cb Update content to call the new template for event definitions 2021-08-27 19:16:42 +01:00
Will 52f5e73a39 Update content to call the new template for HTTP APIs 2021-08-27 19:16:42 +01:00
Will 9f3df1950f
Add changelog page and templates 2021-02-02 20:47:18 -08:00
Will 68370677ef
Use italics instead of code formatting 2021-01-28 16:21:16 -08:00
Will ea9fced092
Formatting fixes for the authentication section 2021-01-24 11:30:45 -08:00
Will fd658f674f
Fix mangling of sub/superscript in e2e module 2021-01-22 15:29:16 -08:00
Will 183ecfda03
Replace sas-emojis template 2021-01-22 14:31:39 -08:00
Will 86152613b1
Remove changelog sections 2021-01-22 14:27:36 -08:00
Will 47f37d5ab5
Remove {{apis}} template 2021-01-22 14:17:16 -08:00
Will 79036a34cc
Update proposals document 2021-01-21 20:41:19 -08:00
Will 965f573c9e
Add example that went missing 2021-01-21 18:23:02 -08:00
Will 3864c11c33
Add content for rooms list page 2021-01-21 17:28:47 -08:00
Will 52745160f3
Use GFM table syntax instead of raw HTML 2021-01-21 17:08:08 -08:00
Will f0a4f59bb0
Fix broken Markdown lists 2021-01-21 09:43:22 -08:00
Will 02a41edc76
Fix heading levels 2021-01-21 09:35:39 -08:00
Will 4e39200cfa
Fix internal links 2021-01-20 21:45:35 -08:00
Will 338434bfcd
Support alerts (notes, warnings, rationales) 2021-01-20 12:34:49 -08:00
Will ab64bda76d
Add syntax highlighting 2021-01-20 10:48:15 -08:00
Will 6c6bd57ebf
Fix ASCII diagrams 2021-01-19 16:41:28 -08:00
Will 55aed1d296
Remove 'unstable' warning 2021-01-19 16:03:15 -08:00
Will 228c737f56
Add support for modules 2021-01-19 15:57:35 -08:00
Will 74adbfc1ec
Remove 'Table of Contents' 2021-01-19 15:32:30 -08:00
Will 9d4803c8af
Remove duplicate titles 2021-01-19 15:30:52 -08:00
Will 19836aa949
Fix headings for Appendices 2021-01-19 15:26:59 -08:00
Will c924b3246f
Add page content as raw Pandoc output 2021-01-19 15:14:52 -08:00
Will ebc6db233b
Add empty page placeholders 2021-01-19 14:15:46 -08:00
Will 985d681645
Use GFM table style 2021-01-18 11:46:05 -08:00
Will 55eae7b70b
Render a single page of the spec in Hugo 2021-01-12 15:31:01 -08:00