Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-06 16:03:42 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
6299 commits 30 branches 42 tags 32 MiB
Commit graph

472 commits

Author SHA1 Message Date
Aaron Raimist 01cd41de68
Add GitHub Action to check spelling (#3591) 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2021-12-28 09:17:49 -07:00
Travis Ralston d2fd90579b Add changelog 2021-12-28 09:16:18 -07:00
Shay 87fcb7c8b0
Clarify that base_url in client well_known may or may not include trailing slash (#3562) 
Fixes #3465. The change adds a line explicitly warning developers that the base_url of client well_known may or may not include a trailing slash and to be prepared to handle both cases.
 2021-12-23 10:12:25 +00:00
Hubert Chathi 71988263f3
clarify which signature to check (#3573) 2021-12-17 08:45:19 -05:00
Richard van der Hoff 7f200c53e8
Move prev_content to unsigned (#3524) 2021-12-02 17:22:58 +00:00
David Robertson 1e12b45f97
Clarifications to /sync description (#3534) 
* Clarify that E0 and E1 are not returned

* Clarify that ASCII art diagram 2 refers to diagram 1

* Correct third ASCII art diagram

To match the spacing in. Borked in the move to new docs format.

55aed1d296/specification/client_server_api.rst (L1610-L1615)

* Make ASCII art 3 follow from ASCII art 2

* Explain how to fill the gap

* Create 3543.clarification

* Update content/client-server-api/_index.md

Co-authored-by: Travis Ralston <travisr@matrix.org>
 2021-12-01 16:28:31 -07:00
Alexandre Franke a26f2f8ca9
Fix typo (#3535) 
* Fix typo

* Add changelog

Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
 2021-12-01 09:49:43 -07:00
Ankur ac98c8c08c
OpenAPI: Add missing required flag in getRoomKeys (#3509) 2021-11-22 13:23:24 -05:00
Will Hunt 51d8560da9
Explicitly link to geo URI spec (#3492) 
* Explicitly link to geo URI spec

* move RFC location

Co-authored-by: Travis Ralston <travisr@matrix.org>

* Create 3492.clarification

Co-authored-by: Travis Ralston <travisr@matrix.org>
 2021-11-15 15:58:39 -07:00
Ankur a034d45e45
typos: Corrected typos in message_pagination.yaml (#3495) 2021-11-15 15:29:07 -05:00
Hubert Chathi 1ad5ff4179
Key name is supposed to be optional, as per MSC2874 (#3481) 2021-11-10 13:48:18 -05:00
Hubert Chathi 033038917d
remove extra type property (#3482) 2021-11-10 13:46:24 -05:00
Travis Ralston 195b8a54c5 v1.1 changelog 2021-11-09 07:23:27 -07:00
Travis Ralston 8f2e8f03d0
Normalize changelog entries (#3476) 
* Remove entries which don't affect the rendered spec (sorry people using the swagger schemas - we'll have to figure out a changelog for you). See https://github.com/matrix-org/matrix-doc/issues/3475
  * Note that a breaking change is removed by this commit: key backup was introduced in this release cycle, so is not breaking.
* Use uniform references to MSCs ("as per MSC0000").
* General rewording to be consistent with the overall voice of the changelog.
* Condensing of entries where needed to make them fit in the changelog.
* Rewording to collapse entries into fewer lines.
* Spell "deprecation" correctly in file extension.
 2021-11-05 13:57:39 -06:00
DeepBlueV7.X 938354b8b4
Rename threepidCreds to threepid_creds and get rid of array (#3471) 
This fixes the behaviour to match what synapse implements in practice.
If you use threepidCreds, you will just get an error about a missing
threepid_creds field. Synapse also treats this as an object. All clients
also seem to send threepid_creds, if they work on Synapse. Since
matrix.org requires an email currently for registration, most clients
that implement registration, will hit this issue.

a0f48ee89d/synapse/handlers/ui_auth/checkers.py (L145)

fixes #3156
fixes #2189

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
 2021-11-04 12:03:53 +00:00
Travis Ralston e8674688e6
Release process: changelog generation and docs (#3446) 
* Remove extra pyprojects and update changelog docs

* Add script for rendering the changelog

* Add docs for how to release the spec

* Move legacy changelogs out of the way
 2021-10-18 10:09:35 -06:00
Travis Ralston 95d850c418
Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 
* Blind find & replace all on client major version -> v3

* Fix up bad replacements

* Fix anchors for r0->v3

* Changelog
 2021-10-12 11:07:01 -06:00
Travis Ralston 2d98cd3084
Describe new global specification versioning (#3420) 
* Update versioning specification for Matrix

As per [MSC2844](https://github.com/matrix-org/matrix-doc/pull/2844)

* Mention vX versioning in /versions

* Changelog
 2021-10-12 11:06:51 -06:00
Travis Ralston b7e6104713
Remove extraneous mimetype from EncryptedFile examples, per MSC2582 (#3412) 
* Remove extraneous mimetype from EncryptedFile examples, per MSC2582

MSC: https://github.com/matrix-org/matrix-doc/pull/2582

* changelog
 2021-09-27 10:05:15 -06:00
Travis Ralston 7e67aa2e23
Clarify how redacted_because actually works for events (#3411) 
* Clarify how redacted_because actually works for events

* changelog

* mention federation

* Fix wording

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2021-09-25 12:44:04 -06: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
Richard van der Hoff 6bd7b6cbb5 Clarifications to pagination parameters for various APIs (#3353) 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
Alexey Rusakov 6d2c388144 Merge pull request #3336 from lukaslihotzki/include-peek-events 
OpenAPI: include peekEvents
 2021-08-27 19:17:18 +01:00
Denis Kasak 14ed131761 Add newsfragment for #3339. (#3342) 2021-08-27 19:17:18 +01:00
Lukas Lihotzki 8a8db03a13 OpenAPI: include peekEvents 
Disambiguate from getEvents by a trailing space in path (like inviteUser).

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Hubert Chathi b231220bbd Merge pull request #3337 from uhoreg/room_create_canonical_alias 
room creation: create canonical alias event if alias specified
 2021-08-27 19:17:17 +01:00
Alexey Rusakov fbf4259a83 Merge pull request #3330 from lukaslihotzki/add-titles 
OpenAPI: add titles
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki 13f7df1379 OpenAPI: add titles 2021-08-27 19:17:17 +01:00
Hubert Chathi f814f86031 add changelog 2021-08-27 19:17:17 +01:00
Hubert Chathi 89089e8913 Merge pull request #3332 from lukaslihotzki/required-bodies 
OpenAPI: require all bodies in cross_signing
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki 1a81a46865 OpenAPI: require all bodies in cross_signing 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki e3070bcdda OpenAPI: fix key_backup operation IDs 2021-08-27 19:17:17 +01:00
Lukas Lihotzki c58d423aba OpenAPI: add auth property in uploadCrossSigningKeys 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Travis Ralston cdcc24af11 Merge pull request #3238 from lukaslihotzki/required-bodies 
OpenAPI: require all bodies in client-server
 2021-08-27 19:17:17 +01:00
Lukas Lihotzki ad0ff78316 OpenAPI: require all bodies in client-server 
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
 2021-08-27 19:17:17 +01:00
Travis Ralston 5d4713f168 Changelog for https://github.com/matrix-org/matrix-doc/pull/3225 2021-08-27 19:17:15 +01:00
Travis Ralston e5b907021c changelog for https://github.com/matrix-org/matrix-doc/pull/3254 2021-08-27 19:17:15 +01:00
Will Hunt 7fac138d9a Create 3233.clarification 2021-08-27 19:17:14 +01:00
Hubert Chathi b3b6fb3e10 add changelog 2021-08-27 19:17:14 +01:00
Andrew Morgan ad93aa6546 Update client_secret examples so that they are valid (#2985) 
The regex of allowed characters for a `client_secret` parameter is `[0-9a-zA-Z.=_-]`.

This PR updates the `client_secret` spec examples, which currently include an invalid character (an apostrophe).
 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 d41658e714 Merge pull request #3166 from matrix-org/travis/spec/msc2033-whoami-deviceid 
Spec device_id on whoami
 2021-08-27 19:17:13 +01:00
Travis Ralston c5eaa59c79 Changelog 2021-08-27 19:17:12 +01:00
Travis Ralston 21a0a97134 changelog 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
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 01a7f06ce4 Add missing endpoint changelog 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 d9bb8f46d1 Add changelogs 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 2d39ed69c3 Add changelogs 2021-08-27 19:17:12 +01:00
Hubert Chathi b2cb2a3c20 add changelog 2021-08-27 19:17:11 +01:00
Hubert Chathi 21fa486b3b add changelog 2021-08-27 19:17:11 +01:00
Hubert Chathi c85f98bdab add changelog 2021-08-27 19:17:11 +01:00
Hubert Chathi c3a234843b add changelog 2021-08-27 19:17:11 +01:00
Hubert Chathi de1a468630 add changelog 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 456353c8b4 Add changelogs 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 4fd262a237 Changelog 2021-08-27 19:17:10 +01:00
Travis Ralston 06d23f04aa Changelog 2021-08-27 19:17:10 +01:00
Travis Ralston 334fc56681 Changelog 2021-08-27 19:17:10 +01:00
Aaron Raimist d540273625 Add changelog 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2021-08-27 19:17:09 +01:00
Will 415199bd3d
Use Markdown in changelog descriptions 2021-02-02 20:43:14 -08:00
Andrew Morgan ba7c0d7f8d Changelog 2020-12-29 18:18:49 +00:00
Hubert Chathi f352de90c3
Merge pull request #2536 from uhoreg/cross-signing-spec 
initial spec for cross-signing
 2020-12-15 13:11:16 -05:00
Travis Ralston e659572183 Add changelogs for 2888 2020-12-07 14:32:58 -07:00
Travis Ralston 8d4d6a12e8 Add missing changelog 2020-11-30 13:40:46 -07:00
Nicolas Werner a0f4ae6b38 Add newsfragment 
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
 2020-11-25 22:29:30 +01:00
Hubert Chathi 7b4ea94f22 add changelog 2020-10-19 19:12:01 -04:00
Aaron Raimist 206b4dfb29
Add changelog 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2020-10-10 13:11:00 -05:00
Travis Ralston d323738db5 Add changelog for 2809 2020-10-08 09:15:49 -06:00
Travis Ralston 2887c715bb
Merge pull request #2795 from matrix-org/travis/spec/msc2367-reason 
Add membership reasons to the spec for all membership events
 2020-10-07 14:51:53 -06:00
Travis Ralston 9ea7b2f5df
Merge pull request #2796 from matrix-org/travis/spec/msc2663-push-errors 
Add 404 error responses to push rule endpoints
 2020-10-07 14:51:29 -06:00
Will dbf74ea85c
Add changelog entry 2020-10-07 10:41:31 -07:00
Will 89d53fd688
Add changelog entry 2020-10-07 09:42:46 -07:00
Travis Ralston 5e60ff8bfd Add 404 error responses to push rule endpoints 
MSC: https://github.com/matrix-org/matrix-doc/pull/2663
 2020-09-30 13:56:12 -06:00
Travis Ralston 5a7bda4bf8 Changelog 2020-09-30 13:45:22 -06:00
Travis Ralston 1bac9fb6e3 Changelog 2020-08-31 15:20:52 -06:00
Travis Ralston d37f7a25b4
Make translations for SAS emoji available in-tree (#2728) 
* add a base file

* Fix directory name

* Added translation using Weblate (English)

* Translated using Weblate (English)

Currently translated at 1.6% (1 of 64 strings)

Translation: matrix-doc/SAS Emoji v1
Translate-URL: https://translate.riot.im/projects/matrix-doc/sas-emoji-v1/en_EN/

* add english files

* delete english files

* Added translation using Weblate (English)

* Added translation using Weblate (English)

* Do manual translations

* Deleted translation using Weblate (English)

* Deleted translation using Weblate (English)

* Add a script to update the definitions with the translations

* update i18n

* Add a note to the spec about translations

* changelog

* Ensure translations end with json
 2020-08-12 14:04:48 -06:00
Patrick Cloke 4353f346b6 Rename changelog file. 2020-07-29 09:18:21 -04:00
Patrick Cloke e261faf70b
Review comments. 
Co-authored-by: Travis Ralston <travpc@gmail.com>
 2020-07-29 07:10:14 -04:00
Patrick Cloke 9a40d7bf47 Add information from MSC2604: Parameters for Login Fallback to the spec. 2020-07-28 16:04:31 -04:00
Travis Ralston 012f0b1882
Merge pull request #2609 from matrix-org/rav/remove_oauth2 
Remove `m.login.token` and `m.login.oauth2` UIA types
 2020-07-28 10:02:24 -06:00
Travis Ralston 24d124df50
Update changelogs/client_server/newsfragments/2609.removal 2020-07-28 10:02:11 -06:00
Hubert Chathi 53e2b999b9
Merge pull request #2687 from uhoreg/sas2_spec 
document new key agreement method for SAS verification and deprecate old method
 2020-07-23 10:24:57 -04:00
Hubert Chathi 33ed9fc2dd apply changes from review 2020-07-21 16:19:53 -04:00
Richard van der Hoff 125614f3a4
Make use of highlight tweak consistent (#2670) 
* remove redundant 'highlight: false' tweaks

their inconsistent usage is super-confusing.

* Remove redundant 'value: true' on highlight tweaks

again, the inconsistency was super-confusing.

* changelog
 2020-07-16 17:26:34 +01:00
Hubert Chathi 793dae1ece add changelog 2020-07-13 16:03:12 -04:00
Travis Ralston adf9443df4
Merge pull request #2669 from matrix-org/rei/bug_type_actions 
Fix spec bug concerning the type of a push rule's array of actions
 2020-07-06 08:33:30 -06:00
Richard van der Hoff 868ca45729
move changelogs to the right directory (#2671) 
looks like these ended up in the wrong place.
 2020-07-06 15:15:29 +01:00
Olivier Wilkinson (reivilibre) 2e72da2343 Fix spec bug concerning the type of a push rule's array of actions 
Signed-off-by: Olivier Wilkinson (reivilibre) <olivier@librepush.net>
 2020-07-06 13:14:27 +01:00
Aaron Raimist f8ff2ad6a9
Reword "UI Authorization" to "User-Interactive Authentication" (#2667) 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2020-07-06 11:19:41 +01:00
Hubert Chathi a91c6446bc
Merge pull request #2639 from uhoreg/backup_version_required 
various key backups fixes
 2020-07-01 12:04:40 -04:00
Hubert Chathi 3e3eafc6ce add changelog 2020-06-23 16:34:48 -04:00
Hubert Chathi 72ad26ec92 fix changelog 2020-06-23 16:24:32 -04:00
Hubert Chathi c8e816d854 Add link to MSC in changelog entries. 2020-06-19 22:22:03 -04:00
Hubert Chathi 83e4d8c413
Merge pull request #2597 from uhoreg/ssss_spec 
initial spec of SSSS
 2020-06-19 21:44:17 -04:00