Commit graph

6752 commits

Author SHA1 Message Date
Kévin Commaille
3af77f0cb4
Fix the table of content for room versions (#1884)
* Fix ToC for room versions pages

Like for the cs-module shortcode, use .RenderShortcodes
instead of .Content for the rver-fragment shortcode,
so the headings are detected by Hugo.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Change the way "this version" is detected in added-in and changed-in shortcodes

Now that we use .RenderShortcodes in the rver-fragment shortcode,
we cannot remove the output of these shortcodes dynamically
because they are replaced by a temporary placeholder due to Hugo's internals.

Instead, since the `this` parameter was only used for room version,
we always use the `v` parameter and compare with the version
provided in the page's front matter.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add version front matter for v11

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Update changelogs/room_versions/newsfragments/1884.clarification

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Travis Ralston <travpc@gmail.com>
2024-06-20 15:47:09 +00:00
Kévin Commaille
18628dc5d7
Allow to specify a prefix for generated HTML IDs of API endpoints (#1882)
* Allow to specify a prefix for generated HTML IDs of API endpoints

Allows to deduplicate IDs of duplicate endpoints

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-06-20 15:39:50 +00:00
Kévin Commaille
bd20d946c4
Fix the rendering of the event format for room versions 1 and 2 (#1883)
* Fix rendering of array with items using anyOf

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Use a single definition for Event Hash

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add ending newline

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-06-20 09:39:44 -06:00
Kévin Commaille
094e25b6cd
Ensure more uniqueness for generated HTML IDs (#1881)
* Include method in all API endpoint children's IDs

Avoids duplicate IDs for object of endpoints
that use the same path but a different method.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Differentiate API endpoints' request and response children's IDs

Ensures that the objects have a unique ID compared to other parts of the endpoint.
Mostly useful for the Error type that can be used for responses with different status codes.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Differentiate the names of both SessionData formats

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-06-20 09:36:33 -06:00
Travis Ralston
8ef84d1cc7 More normalization 2024-06-20 09:26:58 -06:00
Johannes Marbach
27e71fff10
Render added/changed in info on request and response content types (#1876)
* Render added/changed in info on request and response content types

Fixes: #1774
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Kévin Commaille <76261501+zecakeh@users.noreply.github.com>
2024-06-20 09:46:33 +01:00
Kévin Commaille
5fbfdd6821
Fix generated HTML (#1880)
* Add tr as child of thead in HTML tables

It is invalid HTML for th to be the direct children of thead

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Remove unnecessary HTML code end tag

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Avoid nesting p HTML elements

A p HTML element cannot contain other block elements,
so the "parent" element is closed when the first "child" one is opened.

We need to use Page.RenderString with options
to force Hugo to keep the wrapping p elements
even if the content contains a single paragraph.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add missing HTML details end tags

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Replace HTML a self-closing tag with start and end tags

The a element start and end tags are mandatory.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Replace obsolete HTML name attribute with id

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-06-20 09:42:40 +01:00
Travis Ralston
560f29cff3
Update release documentation (Q2 2024 edition) (#1759)
* Update release documentation (Q2 2024 edition)

* changelog

* Drop the ranges we don't follow

* Don't discourage maintenance

* Patch releases just aren't a good idea
2024-06-20 04:08:20 +00:00
Travis Ralston
9c46fa3f35 Normalize the changelog for Matrix 1.11 2024-06-19 21:52:21 -06:00
Kévin Commaille
4e32fca05f
Clarify that an access token is optional on /account/password and /account/deactivate (#1843)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2024-06-18 16:59:26 +01:00
Johannes Marbach
6dfab46268
Fix typo in SRV delegation (#1877)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-18 10:20:57 -04:00
Johannes Marbach
7773716d18
Clarify that asynchronous media upload requires authentication (#1872)
Fixes: #1554
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-14 10:44:01 -04:00
Hugh Nimmo-Smith
5f47b96240
Clarify when server name is used and link to definition (#1862)
* Clarify when server name is used and link to definition

* Changelog
2024-06-14 13:34:35 +02:00
Kévin Commaille
f434fdfba7
Replace references to obsolete RFC 1341 with RFC 2046 (#1869)
* Replace references to obsolete RFC 1341 with RFC 2046

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-06-13 15:37:07 -06:00
Johannes Marbach
672af37cbd
Clarify that relations recursion should be capped at a certain depth (#1854) 2024-06-13 14:34:54 -04:00
Travis Ralston
f38b052569
Use RFC 2119 keywords across the content repository spec (#1861)
* Use RFC 2119 keywords across the content repository spec

* changelog
2024-06-13 12:27:06 -06:00
Travis Ralston
7a51ae879c
Add authenticated media (MSC3916) (#1858)
* C2S: Deprecate now-legacy endpoints

* C2S: Fix MXC URI code block while we're here

* C2S: Describe the authentication and deprecation requirements

* C2S: Intro the upload/download endpoints differently

* C2S: Literally copy/paste the `content-repo.yaml` spec

* C2S: Drop `/upload` and `/create` because we aren't replacing them today

* C2S: Fix notes while we're here

* C2S: Update metadata for new endpoints

* C2S: Add authentication to new endpoints

* C2S: Drop `allow_remote` and `allow_redirect` on new endpoints

* C2S: Append backwards compatibility notes

* C2S: Decorate old media endpoints with pointers to the new ones

The server-server spec might have a harder time linking to these, but that can be fixed with verbiage.

* C2S: Annotate IdP icon spec with media auth implications

* S2S: Modernize section text

* S2S: Create content repository API

This is largely a copy/paste of the new authed content repo API in the Client-Server API, though some keywords (like "client") have been changed. Paths and response formats have also been changed to support the federation-specific requirements.

* C2S & S2S: Add plethora of changelogs

* Reference RFC 1341

* Upgrade keywords in changed text

* Mention caching

* Cross-reference IdP icons

* Update content/client-server-api/modules/content_repo.md
2024-06-13 18:08:27 +00:00
Hugh Nimmo-Smith
4a280bcd87
Clarifications around encoding of data within verification QR codes (#1839) 2024-06-12 22:48:50 +01:00
Richard van der Hoff
cd8ce97563
Minor clarifications to the "end-to-end encryption" module (#1863) 2024-06-12 22:17:37 +01:00
davidegirardi
eb49b28ea9
Use environment variables in workflow (#1865)
* Use environment variables in workflow

* Add newsfragment
2024-06-12 14:14:37 +01:00
Johannes Marbach
7916032a78
Move size limits for user, room and event IDs into the appendix and clarify that the length is to be measured in bytes (#1850)
Fixes: #1826
Relates to: #1001
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-12 09:11:07 +01:00
Johannes Marbach
3517846916
Add missing modules to feature profiles (#1860)
* Add missing modules to feature profiles

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>

* Add changelog

---------

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-11 21:38:33 -04:00
Patrick Cloke
da3e884aaa
Fix broken link to push rule condition kinds. (#1841) 2024-06-11 21:42:46 +00:00
Johannes Marbach
520b8398d8
Add missing word header (#1852)
* Add missing word header

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>

* Add changelog

---------

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-11 17:36:24 -04:00
Kévin Commaille
784b8984f3
Generate ToC with Hugo rather than JavaScript (#1851)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-06-11 22:24:23 +01:00
Patrick Cloke
a7a7eadf2c
Clarify when an event is returned from /send_join. (#1840) 2024-06-11 13:02:46 -04:00
Kévin Commaille
acec09f567
Do not add empty arrays to examples (#1849) 2024-06-11 17:03:53 +01:00
Kévin Commaille
c4b4c896b7
Replace references to RFC7235 and RFC7230 with references to RFC9110 (#1844)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-06-11 16:59:29 +01:00
reivilibre
2f528029c9
Note that /logout doesn't take a body (#1644) 2024-06-11 15:22:12 +01:00
Travis Ralston
08bc8e8a1f
Fix YAML syntax in SCT release template (#1856)
* Fix YAML syntax in SCT release template

* changelog
2024-06-10 12:40:31 -06:00
Travis Ralston
0a9ab956bd Revert "Fix issue template for releases"
This reverts commit 5704276981.
2024-06-10 12:16:14 -06:00
Travis Ralston
5704276981
Fix issue template for releases 2024-06-10 12:15:01 -06:00
Richard van der Hoff
96057638ce
Spec unsigned.membership property, per MSC4115 (#1847) 2024-06-10 12:17:27 +00:00
Johannes Marbach
1b40a7789b
Fix typos around relations recursion (#1853) 2024-06-10 07:26:50 -04:00
Johannes Marbach
7d5b506555
Remove extra preposition in room version 11 description of redactions (#1848)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-07 12:13:32 -04:00
Johannes Marbach
5a86e384dd
Clarify that per-request UIA for /login/get_token is an RFC 2119 MUST requirement (#1846)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-07 08:34:34 +00:00
Kévin Commaille
1e303b3bbc
Do not require UIA when first uploading cross-signing keys (#1828)
As per MSC3967.
2024-06-06 11:06:32 +01:00
Matthew Hodgson
e15a36b0a1
MSC4132: deprecate linking to events in rooms identified by alias (#1823) 2024-06-04 16:20:23 +01:00
Matthias Ahouansou
7ff785fc38
Clarify that the event field of the send_join is only required when performing a restricted join (#1834) 2024-06-03 14:09:40 +01:00
Johannes Marbach
a17550648c
Fix typo in moderation policy lists spec (#1832) 2024-05-31 11:12:31 +01:00
Richard van der Hoff
722c2b1e9a
Clean up pull request template (#1831)
As far as I can tell, these header files only encourage people to create
badly-formatted PRs.

Also we only have one template so let's give it the default name.
2024-05-31 10:02:04 +01:00
Matthias Ahouansou
49765e0e0a
Clarify that redaction events are subject to auth rules (#1824)
Signed-off-by: Matthias Ahouansou <matthias@ahouansou.cz>
2024-05-29 09:42:19 +01:00
Kévin Commaille
ea781ef7b2
Spec markup for mathematical messages (#1816)
* Spec markup for mathematical messages

As per MSC2191.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add warning box

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Improve warning

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add links

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-05-28 16:21:46 -04:00
Sumner Evans
500e83b9b7
e2ee/qr: clarify that the device's Ed25519 signing key should be used (#1829)
Signed-off-by: Sumner Evans <sumner.evans@automattic.com>
2024-05-28 17:36:50 +01:00
Kévin Commaille
3674985dd6
Factor out the common definitions of the content repo APIs and add new formats (#1822)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-05-28 15:38:39 +01:00
Matthias Ahouansou
041be547d6
Fix typo of object being spelt as "obiect" (#1827) 2024-05-24 10:43:33 -06:00
Richard van der Hoff
dac867dd6a
Rename "recovery key" to "backup decryption key" (#1819)
Also, some other editorial improvements, including factoring out our two definitions of the same key encoding algorithm.

Co-authored-by: Travis Ralston <travisr@matrix.org>
2024-05-14 09:35:42 +01:00
Kévin Commaille
b0df8e7fb5
Use patternProperties in more places with supported formats (#1813)
Allows to have more places where the property name's type is better defined.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-05-08 13:59:17 +00:00
Richard van der Hoff
df1e799c51
Spec terms of service at registration (MSC1692) (#1812)
Spec for matrix-org/matrix-spec-proposals#1692

Co-authored-by: Hubert Chathi <hubertc@matrix.org>
2024-05-08 13:51:18 +00:00
Andrew Morgan
f4b34ba962
Note that whitespace around Authorization param commas is allowed (#1818) 2024-05-08 12:22:26 +00:00