Commit Graph

777 Commits (cc7cc4a44d30aa55745848dc7542f4b605d8e76a)

Author SHA1 Message Date
Travis Ralston 00ee4d7010 Add changelog 3 years ago
Aaron Raimist 01cd41de68
Add GitHub Action to check spelling (#3591)
Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
Travis Ralston d2fd90579b Add changelog 3 years ago
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.
3 years ago
Hubert Chathi 71988263f3
clarify which signature to check (#3573) 3 years ago
Richard van der Hoff 7f200c53e8
Move `prev_content` to unsigned (#3524) 3 years ago
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>
3 years ago
Alexandre Franke a26f2f8ca9
Fix typo (#3535)
* Fix typo

* Add changelog

Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Richard van der Hoff dce06f6dc2
Remove C-S `unsigned` data from PDU definitions (#3522)
Remove a bunch of fields from the `unsigned` property of PDUs. These things
shouldn't be passed over the Federation API, and they *really* shouldn't be
trusted if they are sent by another server.

 * `replaces_state` *is* returned by Synapse, but probably shouldn't
   be.
 * `redacted_because`, `prev_sender` and `prev_content` are not sent by Synapse.
3 years ago
Ankur ac98c8c08c
OpenAPI: Add missing `required` flag in `getRoomKeys` (#3509) 3 years ago
Richard van der Hoff f4a0c1aac5
Clarify event format text in room version specs (#3501)
Split the text about event IDs and event formats into separate sections. This
is largely to make it easier to link to, but I think the resulting text makes
more sense too.
3 years ago
Richard van der Hoff 92b29cf8e6
Add a changelog directory for room versions (#3504) 3 years ago
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>
3 years ago
Ankur a034d45e45
typos: Corrected typos in message_pagination.yaml (#3495) 3 years ago
Hubert Chathi 1ad5ff4179
Key name is supposed to be optional, as per MSC2874 (#3481) 3 years ago
Hubert Chathi 033038917d
remove extra `type` property (#3482) 3 years ago
Travis Ralston 195b8a54c5 v1.1 changelog 3 years ago
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.
3 years ago
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>
3 years ago
Travis Ralston 5ea6d5610f
Update identity server spec to use global versioning (#3459)
* Update identity server spec to use global versioning

* changelog
3 years ago
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
3 years ago
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
3 years ago
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
3 years ago
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
3 years ago
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>
3 years ago
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.
3 years ago
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
3 years ago
Richard van der Hoff 6bd7b6cbb5 Clarifications to pagination parameters for various APIs (#3353) 3 years ago
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.
3 years ago
Alexey Rusakov 6d2c388144 Merge pull request #3336 from lukaslihotzki/include-peek-events
OpenAPI: include peekEvents
3 years ago
Denis Kasak 14ed131761 Add newsfragment for #3339. (#3342) 3 years ago
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>
3 years ago
Hubert Chathi b231220bbd Merge pull request #3337 from uhoreg/room_create_canonical_alias
room creation: create canonical alias event if alias specified
3 years ago
Alexey Rusakov fbf4259a83 Merge pull request #3330 from lukaslihotzki/add-titles
OpenAPI: add titles
3 years ago
Lukas Lihotzki 13f7df1379 OpenAPI: add titles 3 years ago
Hubert Chathi f814f86031 add changelog 3 years ago
Hubert Chathi 89089e8913 Merge pull request #3332 from lukaslihotzki/required-bodies
OpenAPI: require all bodies in cross_signing
3 years ago
Alexey Rusakov 3bf7e48e13 Merge pull request #3327 from lukaslihotzki/unique-ids
OpenAPI: fix key_backup
3 years ago
Lukas Lihotzki 1a81a46865 OpenAPI: require all bodies in cross_signing
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
Lukas Lihotzki e3070bcdda OpenAPI: fix key_backup operation IDs 3 years ago
Lukas Lihotzki c58d423aba OpenAPI: add auth property in uploadCrossSigningKeys
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
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>
3 years ago
Travis Ralston cdcc24af11 Merge pull request #3238 from lukaslihotzki/required-bodies
OpenAPI: require all bodies in client-server
3 years ago
Neil Alexander af0ebc7414 `/_matrix/federation/v1/user/devices/{userId}`: Rename `self_signing_keys` to `self_signing_key` (#3312)
Apparently, in response to a /_matrix/federation/v1/user/devices/{userId} request, Synapse actually returns a key called "self_signing_key" instead of "self_signing_keys".
3 years ago
Lukas Lihotzki ad0ff78316 OpenAPI: require all bodies in client-server
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
Travis Ralston 5d4713f168 Changelog for https://github.com/matrix-org/matrix-doc/pull/3225 3 years ago
Travis Ralston e5b907021c changelog for https://github.com/matrix-org/matrix-doc/pull/3254 3 years ago
Will Hunt 7fac138d9a Create 3233.clarification 3 years ago
Travis Ralston 30654f70ee Merge pull request #3176 from matrix-org/travis/clarification/lowercasing
Case fold instead of lowercase
3 years ago
Hubert Chathi 221375b105 Merge pull request #3207 from toadjaune/patch-2
Fix a typo in event soft rejection schema
3 years ago
Travis Ralston 81da7ba480 Update 3167.clarification 3 years ago
Hubert Chathi 53fedb2c61 Add changelog 3 years ago
Travis Ralston 8b40972872 iterate 3 years ago
Hubert Chathi b3b6fb3e10 add changelog 3 years ago
Travis Ralston 21a132d3a5 Merge branch 'master' into travis/clarification/lowercasing 3 years ago
Travis Ralston 7a013a53e5 Changelogs 3 years ago
Travis Ralston 3d217e0de0 Merge pull request #3101 from matrix-org/travis/spec/MSC2320-identity-versions
Add identity service versions API
3 years ago
Travis Ralston c11efb35fe Merge pull request #3163 from matrix-org/travis/spec/msc2858-multisso
Describe social-sign-on (multiple SSO providers)
3 years ago
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).
3 years ago
Travis Ralston fb3dde1c2c Merge pull request #3167 from matrix-org/travis/spec/msc2265-lower-3pid
Specify that email handling converts to lowercase first
3 years ago
Travis Ralston 466911b253 Merge pull request #3170 from matrix-org/travis/spec/msc2713-rm-v1-id
Remove v1 identity service API
3 years ago
Travis Ralston d41658e714 Merge pull request #3166 from matrix-org/travis/spec/msc2033-whoami-deviceid
Spec device_id on whoami
3 years ago
Travis Ralston 67d5d9eb49 Changelog 3 years ago
Travis Ralston c5eaa59c79 Changelog 3 years ago
Travis Ralston 21a0a97134 changelog 3 years ago
Travis Ralston 57f609cf1b Typo fixes 3 years ago
Travis Ralston 94ca646fb7 changelog 3 years ago
Travis Ralston fc6aa30000 Merge branch 'master' into travis/spec/MSC2320-identity-versions 3 years ago
Travis Ralston 457f3995af Merge pull request #3154 from matrix-org/travis/spec/knock-knock-whos-there
Add knocking to the spec
3 years ago
Travis Ralston de19b86eed Changelog 3 years ago
Hubert Chathi ec9ea2b6e3 Merge pull request #3149 from uhoreg/qr_codes_spec
Add spec for verification by QR codes.
3 years ago
Travis Ralston 01a7f06ce4 Add missing endpoint changelog 3 years ago
Hubert Chathi e9e0d8ee47 Merge pull request #3151 from uhoreg/single_ssss_spec
Document Single SSSS.
3 years ago
Travis Ralston d9bb8f46d1 Add changelogs 3 years ago
Hubert Chathi 3084f3d32f Merge pull request #3150 from uhoreg/verification_fixes
Make SAS outline fit with key verification in DM flow.
3 years ago
Travis Ralston 2d39ed69c3 Add changelogs 3 years ago
Hubert Chathi b2cb2a3c20 add changelog 3 years ago
Hubert Chathi 21fa486b3b add changelog 3 years ago
Hubert Chathi c85f98bdab add changelog 3 years ago
Hubert Chathi c3a234843b add changelog 3 years ago
Hubert Chathi de1a468630 add changelog 3 years ago
Travis Ralston 5e211480bf add changelog 3 years ago
Travis Ralston a855ed338b Fix event size restriction (#3127)
Fixes https://github.com/matrix-org/matrix-doc/issues/3126
3 years ago
Travis Ralston 456353c8b4 Add changelogs 3 years ago
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
3 years ago
Travis Ralston 208a0806dd Merge pull request #3098 from matrix-org/travis/spec/r2-MSC2010-MSC2422-MSC2557-color-spoilers
Incorporate spoilers and `color` tag allowance
3 years ago
Travis Ralston 4fd262a237 Changelog 3 years ago
Travis Ralston 06d23f04aa Changelog 3 years ago
Travis Ralston 334fc56681 Changelog 3 years ago
Aaron Raimist d540273625 Add changelog
Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
Will 415199bd3d
Use Markdown in changelog descriptions 4 years ago
Andrew Morgan ba7c0d7f8d Changelog 4 years ago
Hubert Chathi f352de90c3
Merge pull request #2536 from uhoreg/cross-signing-spec
initial spec for cross-signing
4 years ago
Travis Ralston e659572183 Add changelogs for 2888 4 years ago
Travis Ralston 8d4d6a12e8 Add missing changelog 4 years ago
Nicolas Werner a0f4ae6b38 Add newsfragment
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
4 years ago
Hubert Chathi 7b4ea94f22 add changelog 4 years ago
Aaron Raimist 206b4dfb29
Add changelog
Signed-off-by: Aaron Raimist <aaron@raim.ist>
4 years ago
Travis Ralston d323738db5 Add changelog for 2809 4 years ago
Travis Ralston 2887c715bb
Merge pull request #2795 from matrix-org/travis/spec/msc2367-reason
Add membership reasons to the spec for all membership events
4 years ago
Travis Ralston 9ea7b2f5df
Merge pull request #2796 from matrix-org/travis/spec/msc2663-push-errors
Add 404 error responses to push rule endpoints
4 years ago
Will dbf74ea85c
Add changelog entry 4 years ago
Will 89d53fd688
Add changelog entry 4 years ago
Travis Ralston 5e60ff8bfd Add 404 error responses to push rule endpoints
MSC: https://github.com/matrix-org/matrix-doc/pull/2663
4 years ago
Travis Ralston 5a7bda4bf8 Changelog 4 years ago
Travis Ralston 2877459553 Add a link to the push module in the push gateway spec 4 years ago
Travis Ralston 1bac9fb6e3 Changelog 4 years ago
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
4 years ago
Patrick Cloke 4353f346b6 Rename changelog file. 4 years ago
Patrick Cloke e261faf70b
Review comments.
Co-authored-by: Travis Ralston <travpc@gmail.com>
4 years ago
Patrick Cloke 9a40d7bf47 Add information from MSC2604: Parameters for Login Fallback to the spec. 4 years ago
Travis Ralston 012f0b1882
Merge pull request #2609 from matrix-org/rav/remove_oauth2
Remove `m.login.token` and `m.login.oauth2` UIA types
4 years ago
Travis Ralston 24d124df50
Update changelogs/client_server/newsfragments/2609.removal 4 years ago
Hubert Chathi 53e2b999b9
Merge pull request #2687 from uhoreg/sas2_spec
document new key agreement method for SAS verification and deprecate old method
4 years ago
Hubert Chathi 33ed9fc2dd apply changes from review 4 years ago
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
4 years ago
Richard van der Hoff 1b74e96b7e fix RST in changelog 4 years ago
Richard van der Hoff 6da06383e8
Allow `/make_join` to return a 404 (#2688)
Specify that `GET /_matrix/federation/v1/make_join/{roomId}/{userId}` can
return a 404 if the room is unknown.
4 years ago
Hubert Chathi 793dae1ece add changelog 4 years ago
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
4 years ago
Richard van der Hoff 868ca45729
move changelogs to the right directory (#2671)
looks like these ended up in the wrong place.
4 years ago
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>
4 years ago
Aaron Raimist f8ff2ad6a9
Reword "UI Authorization" to "User-Interactive Authentication" (#2667)
Signed-off-by: Aaron Raimist <aaron@raim.ist>
4 years ago
Hubert Chathi a91c6446bc
Merge pull request #2639 from uhoreg/backup_version_required
various key backups fixes
4 years ago
Hubert Chathi 3e3eafc6ce add changelog 4 years ago
Hubert Chathi 72ad26ec92 fix changelog 4 years ago
Hubert Chathi c8e816d854 Add link to MSC in changelog entries. 4 years ago
Hubert Chathi 83e4d8c413
Merge pull request #2597 from uhoreg/ssss_spec
initial spec of SSSS
4 years ago
Jonas Platte 763e5654cc
Make event's title fields UpperCamelCase and distinguish /sync ones 4 years ago
Hubert Chathi b44ebaa32e add changelog 4 years ago
Richard van der Hoff 5cb4b086c7
Clarifications to the push module (#2634)
* Minor clarifications to the push spec
* move conditions before defaults
4 years ago
Nicolas Werner e3d12d6769 Remove room_id from /sync examples
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
4 years ago
Hubert Chathi d261084f5b apply changes from review 4 years ago
Kitsune Ral 49ccfa09a8
Merge pull request #2592 from matrix-org/kitsune/fix-room-versions
capabilities.yaml: drop an extraneous title
4 years ago
Richard van der Hoff da740bfbca
Clarifications to SSO login/UIA (#2608)
including a bunch of text about security
4 years ago
Kitsune Ral 97809c5eae
Update changelogs/client_server/newsfragments/2592.clarification
Co-authored-by: Travis Ralston <travpc@gmail.com>
4 years ago
Richard van der Hoff d9f9706fdb changelog 4 years ago
Richard van der Hoff f632f4a20f
Clarify link to OpenID Connect specification (#2605)
OpenID Connect and OpenID are different things. This seems to be talking about
the former.
4 years ago
Kitsune Ral ea02029f89 Add a changelog 4 years ago
Travis Ralston 29f23a5eda
Merge pull request #2599 from matrix-org/travis/typos
Fix typos and clarify the user ID in login sections
4 years ago
Travis Ralston 9281d0ca13
Merge pull request #2591 from matrix-org/travis/unsigned
Fix a number of issues with unsigned event objects
4 years ago
Hubert Chathi cf37688b7c
Merge pull request #2387 from uhoreg/key_backup_spec
initial version of spec for key backups
4 years ago
Travis Ralston bcce6b9a7c changelog 4 years ago
Hubert Chathi df695167e8 Add changelog. 4 years ago
Dominic Fischer 9535540161
Add changelog 4 years ago
Travis Ralston 33309fb68e Add changelog 4 years ago
Hubert Chathi ec0b9badc7 Merge remote-tracking branch 'origin/master' into cross-signing-spec 4 years ago
Travis Ralston 3fc5540755 Fix r0.1.4 changelog reference 4 years ago
Travis Ralston 07d4606352
Merge pull request #2585 from matrix-org/client_server/release-r0.6.1
Client-Server r0.6.1
4 years ago
Travis Ralston 09986af8fc Server-Server r0.1.4
Includes a link to r0.1.3 because we forgot
4 years ago