d2fd90579b
Add changelog
3 years ago
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
71988263f3
clarify which signature to check ( #3573 )
3 years ago
7f200c53e8
Move `prev_content` to unsigned ( #3524 )
3 years ago
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)
3 years ago
a26f2f8ca9
Fix typo ( #3535 )
...
* Fix typo
* Add changelog
Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
ac98c8c08c
OpenAPI: Add missing `required` flag in `getRoomKeys` ( #3509 )
3 years ago
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
a034d45e45
typos: Corrected typos in message_pagination.yaml ( #3495 )
3 years ago
1ad5ff4179
Key name is supposed to be optional, as per MSC2874 ( #3481 )
3 years ago
033038917d
remove extra `type` property ( #3482 )
3 years ago
195b8a54c5
v1.1 changelog
3 years ago
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
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
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
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
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
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
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
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
6bd7b6cbb5
Clarifications to pagination parameters for various APIs ( #3353 )
3 years ago
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
6d2c388144
Merge pull request #3336 from lukaslihotzki/include-peek-events
...
OpenAPI: include peekEvents
3 years ago
14ed131761
Add newsfragment for #3339 . ( #3342 )
3 years ago
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
b231220bbd
Merge pull request #3337 from uhoreg/room_create_canonical_alias
...
room creation: create canonical alias event if alias specified
3 years ago
fbf4259a83
Merge pull request #3330 from lukaslihotzki/add-titles
...
OpenAPI: add titles
3 years ago
13f7df1379
OpenAPI: add titles
3 years ago
f814f86031
add changelog
3 years ago
89089e8913
Merge pull request #3332 from lukaslihotzki/required-bodies
...
OpenAPI: require all bodies in cross_signing
3 years ago
1a81a46865
OpenAPI: require all bodies in cross_signing
...
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
e3070bcdda
OpenAPI: fix key_backup operation IDs
3 years ago
c58d423aba
OpenAPI: add auth property in uploadCrossSigningKeys
...
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
cdcc24af11
Merge pull request #3238 from lukaslihotzki/required-bodies
...
OpenAPI: require all bodies in client-server
3 years ago
ad0ff78316
OpenAPI: require all bodies in client-server
...
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
3 years ago
5d4713f168
Changelog for https://github.com/matrix-org/matrix-doc/pull/3225
3 years ago
e5b907021c
changelog for https://github.com/matrix-org/matrix-doc/pull/3254
3 years ago
7fac138d9a
Create 3233.clarification
3 years ago
b3b6fb3e10
add changelog
3 years ago
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
c11efb35fe
Merge pull request #3163 from matrix-org/travis/spec/msc2858-multisso
...
Describe social-sign-on (multiple SSO providers)
3 years ago
d41658e714
Merge pull request #3166 from matrix-org/travis/spec/msc2033-whoami-deviceid
...
Spec device_id on whoami
3 years ago
c5eaa59c79
Changelog
3 years ago
21a0a97134
changelog
3 years ago
457f3995af
Merge pull request #3154 from matrix-org/travis/spec/knock-knock-whos-there
...
Add knocking to the spec
3 years ago
ec9ea2b6e3
Merge pull request #3149 from uhoreg/qr_codes_spec
...
Add spec for verification by QR codes.
3 years ago
01a7f06ce4
Add missing endpoint changelog
3 years ago
e9e0d8ee47
Merge pull request #3151 from uhoreg/single_ssss_spec
...
Document Single SSSS.
3 years ago
d9bb8f46d1
Add changelogs
3 years ago
3084f3d32f
Merge pull request #3150 from uhoreg/verification_fixes
...
Make SAS outline fit with key verification in DM flow.
3 years ago
2d39ed69c3
Add changelogs
3 years ago
b2cb2a3c20
add changelog
3 years ago
21fa486b3b
add changelog
3 years ago
c85f98bdab
add changelog
3 years ago
c3a234843b
add changelog
3 years ago
de1a468630
add changelog
3 years ago
a855ed338b
Fix event size restriction ( #3127 )
...
Fixes https://github.com/matrix-org/matrix-doc/issues/3126
3 years ago
456353c8b4
Add changelogs
3 years ago
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
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
4fd262a237
Changelog
3 years ago
06d23f04aa
Changelog
3 years ago
334fc56681
Changelog
3 years ago
d540273625
Add changelog
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
415199bd3d
Use Markdown in changelog descriptions
4 years ago
ba7c0d7f8d
Changelog
4 years ago
f352de90c3
Merge pull request #2536 from uhoreg/cross-signing-spec
...
initial spec for cross-signing
4 years ago
e659572183
Add changelogs for 2888
4 years ago
8d4d6a12e8
Add missing changelog
4 years ago
a0f4ae6b38
Add newsfragment
...
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
4 years ago
7b4ea94f22
add changelog
4 years ago
206b4dfb29
Add changelog
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
4 years ago
d323738db5
Add changelog for 2809
4 years ago
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
9ea7b2f5df
Merge pull request #2796 from matrix-org/travis/spec/msc2663-push-errors
...
Add 404 error responses to push rule endpoints
4 years ago
dbf74ea85c
Add changelog entry
4 years ago
89d53fd688
Add changelog entry
4 years ago
5e60ff8bfd
Add 404 error responses to push rule endpoints
...
MSC: https://github.com/matrix-org/matrix-doc/pull/2663
4 years ago
5a7bda4bf8
Changelog
4 years ago
1bac9fb6e3
Changelog
4 years ago
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
4353f346b6
Rename changelog file.
4 years ago
e261faf70b
Review comments.
...
Co-authored-by: Travis Ralston <travpc@gmail.com>
4 years ago
9a40d7bf47
Add information from MSC2604: Parameters for Login Fallback to the spec.
4 years ago
012f0b1882
Merge pull request #2609 from matrix-org/rav/remove_oauth2
...
Remove `m.login.token` and `m.login.oauth2` UIA types
4 years ago
24d124df50
Update changelogs/client_server/newsfragments/2609.removal
4 years ago
53e2b999b9
Merge pull request #2687 from uhoreg/sas2_spec
...
document new key agreement method for SAS verification and deprecate old method
4 years ago
33ed9fc2dd
apply changes from review
4 years ago
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
793dae1ece
add changelog
4 years ago
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
868ca45729
move changelogs to the right directory ( #2671 )
...
looks like these ended up in the wrong place.
4 years ago
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
f8ff2ad6a9
Reword "UI Authorization" to "User-Interactive Authentication" ( #2667 )
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
4 years ago
a91c6446bc
Merge pull request #2639 from uhoreg/backup_version_required
...
various key backups fixes
4 years ago
3e3eafc6ce
add changelog
4 years ago
72ad26ec92
fix changelog
4 years ago
c8e816d854
Add link to MSC in changelog entries.
4 years ago
83e4d8c413
Merge pull request #2597 from uhoreg/ssss_spec
...
initial spec of SSSS
4 years ago
763e5654cc
Make event's title fields UpperCamelCase and distinguish /sync ones
4 years ago
b44ebaa32e
add changelog
5 years ago
5cb4b086c7
Clarifications to the push module ( #2634 )
...
* Minor clarifications to the push spec
* move conditions before defaults
5 years ago
e3d12d6769
Remove room_id from /sync examples
...
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
5 years ago
d261084f5b
apply changes from review
5 years ago
49ccfa09a8
Merge pull request #2592 from matrix-org/kitsune/fix-room-versions
...
capabilities.yaml: drop an extraneous title
5 years ago
da740bfbca
Clarifications to SSO login/UIA ( #2608 )
...
including a bunch of text about security
5 years ago
97809c5eae
Update changelogs/client_server/newsfragments/2592.clarification
...
Co-authored-by: Travis Ralston <travpc@gmail.com>
5 years ago
d9f9706fdb
changelog
5 years ago
f632f4a20f
Clarify link to OpenID Connect specification ( #2605 )
...
OpenID Connect and OpenID are different things. This seems to be talking about
the former.
5 years ago
ea02029f89
Add a changelog
5 years ago
29f23a5eda
Merge pull request #2599 from matrix-org/travis/typos
...
Fix typos and clarify the user ID in login sections
5 years ago
9281d0ca13
Merge pull request #2591 from matrix-org/travis/unsigned
...
Fix a number of issues with unsigned event objects
5 years ago
cf37688b7c
Merge pull request #2387 from uhoreg/key_backup_spec
...
initial version of spec for key backups
5 years ago
bcce6b9a7c
changelog
5 years ago
df695167e8
Add changelog.
5 years ago
9535540161
Add changelog
5 years ago
33309fb68e
Add changelog
5 years ago
ec0b9badc7
Merge remote-tracking branch 'origin/master' into cross-signing-spec
5 years ago
19a97c62e2
Client-Server r0.6.1
5 years ago
e14cf35c80
Merge pull request #2563 from matrix-org/travis/spec/2240-and-assoc--r-v6
...
Room Version 6
5 years ago
c3289614da
Merge pull request #2562 from matrix-org/travis/spec/2432-alias-semantics
...
Add spec for new alias handling (client-server)
5 years ago
04a26dafd0
Merge pull request #2546 from matrix-org/travis/spec/1466-softlogout
...
Spec soft-logout per MSC1466
5 years ago
9bdafab2a4
Merge pull request #2571 from matrix-org/travis/clarification/createRoom-events
...
Clarify that a creation event and member event are needed for createRoom
5 years ago
56ba0c7862
Merge pull request #2574 from matrix-org/travis/clarification/member-profiles
...
Remove claim that profile info is exclusively managed by the server
5 years ago
a1177cbd61
Merge pull request #2566 from uhoreg/remove_string_string_string
...
E2E clarifications/improvements
5 years ago
e8548f3c3b
Remove claim that profile info is exclusively managed by the server
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2496
5 years ago
200212ffd7
Clarify that a creation event and member event are needed for createRoom
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2494
5 years ago
730d164df7
Add changelogs
5 years ago
bdd8f03fef
Add changelog
5 years ago
98416bf948
Add changelog for client-server API
5 years ago
2b6086d87c
Add changelog entries
...
It's a bit awkward that this shows up as a backwards compatible change, but it's also not breaking.
5 years ago
c2d5516517
Clobber changelogs
5 years ago
a7e7496cd6
Fix some numbers in the spec text.
...
Odds were not written as an exponent.
Special tag names count was not updated.
Fixes #2550
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
5 years ago
c3582e5fc6
Add changelog
5 years ago
bd26a41114
off by one error
5 years ago
d24f15a3a9
Spec soft-logout per MSC1466
...
MSC: https://github.com/matrix-org/matrix-doc/issues/1466
5 years ago
f97b394591
add changelogs
5 years ago
10293d6951
Merge pull request #2532 from matrix-org/clokep/sso-login
...
Add MSC2454 to the specification.
5 years ago
78f8d1322f
Add MSC2454 to the specification.
5 years ago
0d2924841b
Merge pull request #2524 from uhoreg/e2e_misc_fixes_202005
...
misc fixes in e2ee spec
5 years ago
6ede023b35
make the changelog match others so they get combined
5 years ago
9980b83dd4
add changelog
5 years ago
b0e8fd648d
Apply suggestions from code review
5 years ago
3054ac572f
changelogs: Fragment for the event id when putting room events clarification.
5 years ago
0c582ea8c7
Apply suggestions from code review
...
Co-authored-by: Travis Ralston <travpc@gmail.com>
5 years ago
958e1b4a2e
Make the spec changes for MSC 2457.
5 years ago
411b3f432b
Update changelog
5 years ago
b8efb5ac47
Add changelog for 2519
...
Signed-off-by: David Vo <david@vovo.id.au>
5 years ago
b908b8e777
Add changelog
5 years ago
f7ce75d36c
Support a 'removed endpoints' changelog type
5 years ago
7666b9fea7
Add changelog for name correction
...
https://github.com/matrix-org/matrix-doc/pull/2453
5 years ago
f823118a69
Merge pull request #2434 from matrix-org/travis/spec/2313-moderation-policies
...
Spec moderation policy rooms (MSC2313)
5 years ago
7a878bb6c3
Fix location of changelog entries and synergize them
5 years ago
da047523e3
Changelog
5 years ago
6911171e83
Fix key export format example
...
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
5 years ago
715d2d674b
Add changelog for spelling.
5 years ago
90bf2b3b46
add changelog
5 years ago
21b50d749a
Merge pull request #2369 from iinuwa/token-auth-doc-tweaks
...
Rename nonce to txn_id. Reorganize for clarity.
5 years ago
7cfc4b09a6
Changelog
5 years ago
4d0bd5b9e2
Changelog
5 years ago
d93d8fe9b5
Add a changelog
5 years ago
f361c756d2
Client Server r0.6.0 release
5 years ago
14d609e766
Merge pull request #2344 from matrix-org/travis/spec/fix-2338
...
Add filter query param to /context
5 years ago
8e6e47ae7d
Merge pull request #2343 from matrix-org/travis/spec/fix-2120
...
Recommend that clients don't preview URLs in encrypted rooms
5 years ago
ef957b990d
Merge pull request #2341 from matrix-org/travis/spec/fix-2298
...
Clarify that submit_url is without authentication
5 years ago
a50e828509
Merge pull request #2342 from matrix-org/travis/spec/fix-1982
...
Clarify what format the `country` is on phone number inputs
5 years ago
3d954f93b5
Clarify that the room ID is the object key in /sync responses
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2269
5 years ago
021c056efc
Add filter query param to /context
...
This was missed as part of lazy-loading.
Fixes https://github.com/matrix-org/matrix-doc/issues/2338
5 years ago
b662a33081
Recommend that clients don't preview URLs in encrypted rooms
...
Any stronger of a recommendation would probably require a MSC due to the behaviour change.
Fixes https://github.com/matrix-org/matrix-doc/issues/2120
5 years ago
284b15495b
Clarify what format the `country` is on phone number inputs
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1982
5 years ago
1dfe2ade08
Changelog
5 years ago
156fbfb4c7
Merge pull request #2311 from matrix-org/travis/fix-changelog-again
...
Fix client-server typos changelog
5 years ago
3d60e04c6a
Merge pull request #2310 from matrix-org/travis/spec/2263-deprecate-id-server
...
Deprecate id_server and make it optional
5 years ago
b59998fd2b
Fix client-server typos changelog
...
Note: .misc is not a valid changelog entry.
5 years ago
2e84465c13
Changelog
5 years ago
6b37bb1dd9
Merge remote-tracking branch 'remotes/origin/master' into kitsune-map-to-enum-support
5 years ago
79f16d40a9
Add a full stop
...
Co-Authored-By: Travis Ralston <travpc@gmail.com>
5 years ago
30a9de7e02
Merge branch 'master' into travis/spec/is-unbind
5 years ago
f7e00b19e9
Merge pull request #2255 from matrix-org/travis/spec/is-auth
...
Spec the v2 IS auth APIs
5 years ago
185c564a13
Spec client-server IS unbind API
...
As per [MSC2140](https://github.com/matrix-org/matrix-doc/pull/2140 )
Note: this modifies the endpoint in MSC2140 to be more in line with the remainder of the proposal.
5 years ago
2d784d93ef
Merge branch 'master' into travis/spec/is-auth
5 years ago
6ec7d4cd89
changelog
5 years ago
caf46db6e7
Changelog
5 years ago
aa98137514
Add changelog
5 years ago
35eb1993d9
Add a changelog fragment for the room key request action fix.
5 years ago
31c132ec82
Add changelog
5 years ago
92c6f4c38e
Add M_USER_DEACTIVATED to list of error codes ( #2234 )
...
Spec PR for [MSC 2181](https://github.com/matrix-org/matrix-doc/pull/2181 ).
Adds the `M_USER_DEACTIVATED` error code and a short description to the client-server API.
5 years ago
a171d5f6fd
Check for a state_key on the tombstone push rule
...
This is an oversight from the proposal.
5 years ago
a63fab20ee
Fix some typos
...
Signed-off-by: Dominic Fischer <dominicfischer7@gmail.com>
5 years ago
28596a6c74
Add missing changelog for #2204 .
5 years ago
62f7a4f82c
Fix/add changelogs
...
The push spec one was missed in https://github.com/matrix-org/matrix-doc/pull/2151
5 years ago
9ed19a37ad
Client-server: Fix upload keys example request
...
Contributes to #1733
Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
5 years ago
9208c5cd13
Add changelog
5 years ago
e88a074c9f
Add changelog
5 years ago
ace94f02b7
Merge pull request #2132 from jimmycuadra/clarify-m.key.verification.start
...
Clarify the distinction between *m.key.verification.start* and its *m.sas.v1* variant.
6 years ago
8246383330
Fix typos in changelog entry.
6 years ago
204601d9a4
Merge pull request #2133 from matrix-org/travis/fix-olm-2
...
Fix link to Olm signing specification
6 years ago
c63b5aff69
Create 2136.clarification
6 years ago
33ca891e71
Fix link to Olm signing specification
...
See https://github.com/matrix-org/matrix.org/issues/478
6 years ago
5384b61d95
Fix style issues brought up during code review.
...
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
6 years ago
bc71dacaf4
Clarify the distinction between *m.key.verification.start* and its *m.sas.v1* variant.
...
Currently the *m.key.verification.start* event appears twice with the
exact same title, in the "Key verification framework" section and the
"Short Authentication (SAS) verification" section. It's not immediately
clear that the first occurrence describes the format of the event in
general terms and that the second occurrence describes the fields when
the *m.sas.v1* verification method is being used. This is a similar
relationship to the *m.room.message* event and its various *msgtype*
variants.
This commit does three things:
* It tweaks the generation of the documentation to change the title
of the second occurrence of *m.key.verification.start* to
distinguish it from the first.
* It updates the language in the description of the two versions of the
event to better describe the relationship between the two.
* It adds the optional `next_method` field to the schema of the
*m.sas.v1* variant, as specified in the general form of
*m.key.verification.start*.
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
6 years ago
b807e1cbe5
Merge pull request #2129 from jimmycuadra/conditionally-required-url-fields
...
Remove the "required" designation from the `url` field of certain m.room.message msgtypes.
6 years ago
b885714d94
Remove the "required" designation from the `url` field of certain
...
m.room.message msgtypes.
Now that content referenced by the *m.audio*, *m.file*, *m.image*, and
*m.video* message types can be encrypted, the `url` field is required
*only* if the content is unencrypted. The "required" designation in the
event schemas (which prefixes the field description with "Required" in
bold in the generated HTML) is used to indicate fields which must always
be present, and this is no longer the case.
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
6 years ago
2dd0da7d50
Fix typo in key verification framework section.
...
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
6 years ago
e670fb1f5a
Add missing format fields to m.room.message$m.notice schema.
...
Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
6 years ago
1ca60bf5d7
Client-Server r0.5.0
6 years ago
2d18f81807
Merge pull request #2087 from matrix-org/travis/1.0/events-are-extensible
...
Reorganize event structure in c2s spec and clarify event capabilities
6 years ago
8ac555f870
Merge pull request #2083 from matrix-org/travis/1.0/key-object
...
Clarify the key object definition for the key management API
6 years ago
19f017f9bd
Merge pull request #2035 from matrix-org/travis/1.0/msc688-msc1227-lazy-loading
...
Spec lazy-loading room members
6 years ago
fbdb56a29f
Merge pull request #2101 from matrix-org/anoa/hs_3pid_tokens
...
Add submit_url field to requestToken responses, clarify HS's can send tokens themselves
6 years ago
370ae8b9fe
Merge pull request #2068 from matrix-org/travis/1.0/mxc
...
Refactor documentation for content/media repository
6 years ago
c1c26859e2
Merge pull request #2096 from matrix-org/travis/1.0/read-notifs
...
Clarify how notification counts are calculated in /sync
6 years ago
39b79fe453
Merge pull request #2088 from matrix-org/travis/1.0/duplicate-state-endpoint
...
Merge GET/PUT /state/:event_type endpoints
6 years ago
572d29348c
Update changelogs/client_server/newsfragments/2101.breaking
...
Co-Authored-By: Travis Ralston <travpc@gmail.com>
6 years ago
32761fc108
Merge pull request #2098 from matrix-org/travis/1.0/modules-update
...
Clarify what a "module" is and update feature profiles for clients
6 years ago
f047e235df
Merge branch 'master' into travis/1.0/event-ids
6 years ago
7fe7d365e2
Merge pull request #2089 from matrix-org/travis/1.0/cors
...
Clarify when and where CORS headers should be returned
6 years ago
0f82056ca2
Highlight breaking change
6 years ago
ab0c1bc054
Add changelog, update imperative check, rename sid.yaml
6 years ago
4b6e2cc956
Merge pull request #2072 from matrix-org/travis/1.0/msc1717-msc1267-sas-verification
...
Spec SAS verification and the common key verification framework
6 years ago
906d3cd447
Merge pull request #2055 from matrix-org/travis/1.0/registration-clarification
...
Clarify guest accounts and `auth` usage on /register
6 years ago
f4e85853d4
Merge pull request #2054 from matrix-org/travis/1.0/uia-clarifications
...
Clarify that UIA stages cannot be attempted twice
6 years ago
9cf03325b9
Merge pull request #2046 from matrix-org/travis/1.0/msc1915-unbind
...
Spec 3PID unbind API
6 years ago
70da564e2b
Merge pull request #2067 from matrix-org/travis/1.0/stripped-state
...
Clarify exactly what StrippedState is
6 years ago
cd6b012523
Clarify what a "module" is and update feature profiles for clients
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2009
6 years ago
f0eb495cee
Clarify how notification counts are calculated in /sync
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
6 years ago
e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn
...
Spec MSISDN UIA support
6 years ago
976f32fcab
Clarify that /register must produce valid Matrix User IDs
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1793
6 years ago
79bbb47d9f
Clarify when authorization and rate-limiting are not applicable
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1971
6 years ago
bbc7401973
Clarify when and where CORS headers should be returned
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1736
Fixes https://github.com/matrix-org/matrix-doc/issues/2013
6 years ago
c8a3850598
Merge GET/PUT /state/:event_type endpoints
...
Clarifying that the state key is optional, and how that works.
Fixes https://github.com/matrix-org/matrix-doc/issues/1182
6 years ago
8fd5b15594
Reorganize event structure in c2s spec and clarify event capabilities
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1166
Fixes https://github.com/matrix-org/matrix-doc/issues/1527
Fixes https://github.com/matrix-org/matrix-doc/issues/1827
Note: In order to fix the "state events have the following fields: [no words]" bug (1827) we need to resolve references on common event types. When doing this we ultimately end up with more fields than may be required to explain the section, however this commit alters the section descriptions to just say "these fields" instead of "these additional fields".
This is also preferable over trying to get the inheritance reversed in the common event types, as the `/sync` endpoint has a high amount of reliance on partial events definitions.
6 years ago
a19eb59f13
Clarify the key object definition for the key management API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1907
One too far
6 years ago
9ac89cc915
Merge pull request #2056 from matrix-org/travis/1.0/membership-table
...
Add a table to show how changes in membership should be interpreted
6 years ago
aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned
...
Fix third party signed definitions for join APIs
6 years ago
e8d6a57a2e
Merge pull request #2052 from matrix-org/travis/1.0/pushrules-kind
...
Change reference for definition of push rule condition kinds
6 years ago
a3364ff357
Spec SAS verification and the common key verification framework
...
Reference implementations:
* 94f664e725https://github.com/matrix-org/matrix-react-sdk/pull/2461
* https://github.com/matrix-org/matrix-js-sdk/pull/818
* https://github.com/matrix-org/matrix-react-sdk/pull/2596
* https://github.com/matrix-org/matrix-js-sdk/pull/837
Proposals:
* [MSC1717](https://github.com/matrix-org/matrix-doc/pull/1717 )
* [MSC1267](https://github.com/matrix-org/matrix-doc/issues/1267 )
No alterations to either proposal have been made intentionally here.
6 years ago
9cb60fa468
Merge pull request #2059 from matrix-org/travis/1.0/msc1719-olm-unwedge
...
Add Olm unwedging
6 years ago
042455d954
Update changelog to appease style guidelines
6 years ago
8b28972a2d
PR feedback
6 years ago
1f86e8e31b
Refactor documentation for content/media repository
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2060
Fixes https://github.com/matrix-org/matrix-doc/issues/772
Fixes https://github.com/matrix-org/matrix-doc/issues/888
6 years ago
7a07a6b358
Clarify exactly what StrippedState is
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2066
The expectation everywhere is that the `sender` is required. `/initialSync` references StrippedState through a `m.room.member` event reference, and does not need editing.
6 years ago
d7f37f92eb
Merge branch 'master' into travis/1.0/fix-examples
6 years ago
ff768ec75f
Merge pull request #2036 from matrix-org/travis/1.0/wk-fail-error
...
Clarify that FAIL_ERROR is not limited to just homeservers.
6 years ago
54f74cd877
Add Olm unwedging
...
As per [MSC1719](https://github.com/matrix-org/matrix-doc/pull/1719 )
No known alterations have been made to the proposal.
Implementation proof: https://github.com/matrix-org/matrix-js-sdk/pull/780
6 years ago
a2f955b50d
Merge pull request #2053 from matrix-org/travis/1.0/required-urls
...
Make url required for m.file-like messages
6 years ago
ff33b470a4
Merge pull request #2039 from matrix-org/travis/1.0/more-changelogs
...
Fix more changelog entries
6 years ago
f3c0c5232f
Add a table to show how changes in membership should be interpreted
...
Fixes https://github.com/matrix-org/matrix-doc/issues/876
6 years ago
2ed37f5bf4
Clarify guest accounts and `auth` usage on /register
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1980
Fixes https://github.com/matrix-org/matrix-doc/issues/1984
6 years ago
0f623113f1
Clarify that UIA stages cannot be attempted twice
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1987
Note: Synapse currently does not care, however the spirit of the text in the spec implies that completed == done forever, so we're just reinforcing it here.
6 years ago
464845feb0
Make url required for m.file-like messages
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2008
This also removes `filename` from `m.file` because it has never been used in practice.
6 years ago
792bb8faa4
Renumber changelog to match PR
6 years ago
f9472bae41
Change reference for definition of push rule condition kinds
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1970
6 years ago
d2232aca97
Merge pull request #2042 from matrix-org/travis/1.0/ordered-flows
...
Clarify that login flows must be completed in order
6 years ago
c25afa663e
Use consistent event examples throughout the Client-Server API
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1968
6 years ago
4452ebf371
Merge pull request #2041 from matrix-org/travis/1.0/upload-mime-example
...
Fix example Content-Type for /media/upload request
6 years ago
0463084924
Spec 3PID unbind API
...
As per [MSC1915](https://github.com/matrix-org/matrix-doc/pull/1915 )
Implementation proof:
* https://github.com/matrix-org/synapse/pull/4982
* https://github.com/matrix-org/sydent/pull/160
The only alteration made which differs from the proposal is clarity on how to handle homeservers not knowing the `id_server`. All other differences are unintentional.
6 years ago
a8f61697d1
Merge pull request #2032 from matrix-org/travis/1.0/redaction-effects
...
Clarify how redactions affect room state
6 years ago
2cf00fc5ca
Merge pull request #2031 from matrix-org/travis/1.0/voip-hangup
...
Add missing reason property to m.call.hangup
6 years ago
bf86b4b83c
Fix incorrect PR reference on changelog
6 years ago
4e58414b26
Clarify that clients should not ack their own messages
...
Fixes https://github.com/matrix-org/matrix-doc/issues/567
6 years ago
572a6056ad
Clarify that login flows must be completed in order
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1134
Evidence of this being the case is shown here: https://github.com/matrix-org/synapse/pull/5174
6 years ago
62890d21b2
Fix example Content-Type for /media/upload request
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1770
6 years ago
10648aa9e8
Clarify that FAIL_ERROR is not limited to just homeservers.
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1735
6 years ago
bf8ca3abba
Merge pull request #2026 from matrix-org/travis/1.0/msc1452-server-notices
...
Add server notices support
6 years ago
b1dccda49d
changelog
6 years ago
40cf4620d5
Merge pull request #2027 from matrix-org/travis/1.0/pw-change-uia
...
Add rationale for UIA on change password, and how access tokens behave
6 years ago
1aa71f2436
Merge pull request #2029 from matrix-org/travis/1.0/delete-alias
...
Add M_NOT_FOUND definition for deleting non-existent aliases
6 years ago
23ab1c527a
Clarify how redactions affect room state
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1726
6 years ago
00f97636a2
Add missing reason property to m.call.hangup
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1689
6 years ago
1bda3fe2b2
Spec MSISDN UIA support
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1702
1702 describes the lack of `bind_msisdn` parameter, however the whole login type was missing from UIA.
6 years ago
d52fcdacfa
Add M_NOT_FOUND definition for deleting non-existent aliases
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1675
6 years ago
221d9f24fd
Clarify that logging out deletes devices too
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1651
6 years ago
1d33adf62d
Add rationale for UIA on change password, and how access tokens behave
...
Fixes https://github.com/matrix-org/matrix-doc/issues/680
6 years ago
5eea4a477f
Add server notices support
...
As per [MSC1452](https://github.com/matrix-org/matrix-doc/issues/1452 )
Fixes https://github.com/matrix-org/matrix-doc/issues/1254
Although MSC1452 focuses on just the warnings part of the server notices, the base for notices has not been established in the spec. This commit adds the needed support to be able to handle notices.
No intentional divergences from the proposal are included in this changeset. There are a few additions which are used in practice although not defined in the proposal, such as who is responsible for aesthetics, sending notices, and other misc rules.
6 years ago
17a9524cad
changelog
6 years ago
5c268ef21f
Merge pull request #2020 from matrix-org/travis/1.0/msc1930-tombstone-notif
...
Add a .m.rule.tombstone default push rule for room upgrades
6 years ago
ceaccffdf7
Add a .m.rule.tombstone default push rule for room upgrades
...
As per [MSC1930](https://github.com/matrix-org/matrix-doc/pull/1930 )
There are no known changes to this proposal since it was accepted.
6 years ago
3c38956510
Remove prev_content from the redaction essential keys list
...
As per [MSC1954](https://github.com/matrix-org/matrix-doc/pull/1954 )
No known changes since the proposal was accepted.
6 years ago
9c2a789d34
Add missing changelogs and make existing ones match conventions
...
The conventions are not set in stone, however the changelog should not be a mixed bag of voices.
6 years ago
ba18a6e9fa
Merge pull request #1992 from matrix-org/anoa/missing_punctuation3
...
Add missing period
6 years ago
00b7b70c06
Create 1992.clarification
6 years ago
7e093e95fc
Merge pull request #1991 from matrix-org/anoa/missing_punctuation2
...
Add missing punctuation
6 years ago
c54a5fc3df
Merge pull request #1989 from matrix-org/anoa/typo2
...
Add missing 'as'
6 years ago
713e4401b4
Add changelogs
6 years ago
abd770419b
Add changelog
6 years ago
20d2fdc288
Add changelog
6 years ago
14715468bb
Make thumbnail dimensions mandatory
...
Fixes #1883
6 years ago
76ee13b9bb
Fixed bad spacing.
6 years ago
c08d223cfe
Merge pull request #1889 from ma1uta/push_rules
...
Fix for the #1865
6 years ago
5303ba54b7
Add a clarification changelog.
6 years ago
adb721bc0b
Fix unrelated changelog entry's RST representation
6 years ago
baf8948eb5
Describe M_UNSUPPORTED_ROOM_VERSION on invite and createRoom endpoints
...
Spec for MSC1866: https://github.com/matrix-org/matrix-doc/pull/1866
6 years ago
49119ed345
Merge pull request #1875 from matrix-org/travis/clarify-upgrades
...
Clarify the recommendations for "transferable state"
6 years ago
72242e4ebb
Merge pull request #1879 from matrix-org/travis/fix-capabilities
...
Correctly nest the capabilities response object
6 years ago
d31d2f5e57
Correctly nest the capabilities response object
...
Everything is contained in a "capabilities" property, which is not represented by the schema. The example was correct.
6 years ago
48569c2156
Merge pull request #1853 from matrix-org/anoa/3pid_typos
...
Replace "3pid" with "3PID"
6 years ago
26810bccef
Merge pull request #1873 from matrix-org/travis/spec/get-account-data
...
Add routes for retrieving account data
6 years ago
df7223f992
Add changelogs
6 years ago
f67782230a
changelog
6 years ago
5721712eae
Add M_RESOURCE_LIMIT_EXCEEDED
...
Original proposal: https://github.com/matrix-org/matrix-doc/issues/1504
No changes from the original proposal or implementations have been made intentionally here.
6 years ago
6bbf22cd04
Add routes for retrieving account data
...
Original proposal: https://github.com/matrix-org/matrix-doc/issues/1339
This contains no known differences to what was ultimately decided upon and implemented.
6 years ago
85578f9842
Fix spelling mistake: endponts -> endpoints
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1677
6 years ago
e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists
...
remove references to presence lists
6 years ago
ccce6c196d
Specify how capabilities work in the c2s API
...
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1753
* https://github.com/matrix-org/matrix-doc/pull/1804
Implementation proof:
* https://github.com/matrix-org/synapse/pull/4472
* https://github.com/matrix-org/matrix-js-sdk/pull/830
There is one change to MSC1753 which is included in this commit. MSC1804 remains unchanged. In the original proposal, the change password capability being present was an indication that password changes were possible. It was found that this doesn't really communicate the state very well to clients in that lack of a capability (or a 404, etc) would mean that users would erroneously not be able to change their passwords. A simple boolean flag was added to assist clients in detecting this capability.
6 years ago
4437c383bb
Merge pull request #1790 from matrix-org/travis/spec/login-redirect
...
Add a mechanism for redirecting clients after login
6 years ago
ed68f940cd
towncrier
6 years ago
84a4ca62c3
Merge pull request #1786 from matrix-org/travis/spec/exp-caps
...
Add support for unstable feature advertising via /versions
6 years ago
052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades
...
Add room version upgrades
6 years ago
5f12419afb
Clarify that changelog entries end with a full stop
6 years ago
56bfa76765
changelog
6 years ago
fbd8861180
Changelog
6 years ago
510468a3b1
Changelog
6 years ago
75c084e987
changelog
6 years ago
7461cd7f68
Add changelog
6 years ago
1be3bd602a
add changelog
6 years ago
485928486a
Client-server r0.4.0 changelog
6 years ago
17a6a4c2ee
Merge branch 'travis/c2s/fix-changelog' into client_server/release-r0.4.0
6 years ago
bb2835651f
Merge pull request #1637 from turt2live/travis/c2s/clarify-errors
...
List known client-server error codes; Clarify priority of error codes vs http status code
6 years ago
680ab5e194
Misc formatting things
...
Consistency, make the renderer happy
6 years ago
247ae26ec4
Consistency
6 years ago
d5af3bae43
This isn't a new endpoint
6 years ago
683072e624
Merge pull request #1636 from turt2live/travis/c2s/id-server
...
Clean up and flesh out all three editions of the /requestToken API
6 years ago
108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers
...
Add read markers
6 years ago
e49ed5d1ec
Changelog
6 years ago
c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach
...
Document encrypted attachments
6 years ago
3146fc339a
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-errors
6 years ago
679ddabb53
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers
6 years ago
7f1b94c211
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/id-server
6 years ago
9004be7bda
Merge remote matrix-org/master
6 years ago
25778989a1
Merge pull request #1573 from turt2live/travis/c2s/sync-event-fields
...
Fix event schemas for /sync
6 years ago
f72c821be4
Merge pull request #1619 from turt2live/travis/c2s/local-echo
...
Reference that transaction IDs may be used to echo
6 years ago
2e3e189ea2
Merge remote matrix-org/master
6 years ago
136ba15eb2
Merge pull request #1605 from turt2live/travis/c2s/clarify-html-again
...
Mention that clients should not be producing invalid HTML
6 years ago
afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags
...
Update the room tagging documentation
6 years ago
c127eed7e7
Merge pull request #1600 from turt2live/travis/c2s/media-csp
...
Specify the minimum CSP for media
6 years ago
73736d41db
Merge pull request #1569 from turt2live/travis/c2s/user-directory
...
Clarify the homeserver's behaviour for user searching
6 years ago
9646d99c9e
Merge pull request #1602 from turt2live/travis/general/redactions
...
Add the other fields the server is expected to keep on events
6 years ago
ac56e76746
Changelog
6 years ago
7f719b23e7
Merge pull request #1589 from turt2live/travis/c2s/inhibit-login
...
Document the inhibit_login registration option
6 years ago
f3181bbedd
Changelog
6 years ago
7516af3df2
Changelog
6 years ago
86c85aea71
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/3pid-binding
6 years ago
951b442956
Merge pull request #1558 from turt2live/travis/c2s/fix-events
...
Fix client-server event schemas: move `age`, dedupe fields
6 years ago
2d18b0d2d8
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-html-again
6 years ago
49c5677969
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/user-directory
6 years ago
440841d1ff
Recommend a CSP rather than require it.
6 years ago
f04afaa9b9
Merge pull request #780 from mujx/missing-enum-fields
...
Add missing enum fields for the set_presence parameter
6 years ago
827033c128
Merge remote matrix-org/master
6 years ago
7ecf2406eb
Merge pull request #1590 from turt2live/travis/c2s/403-put-state
...
Document 403 error for sending state events
6 years ago
Travis Ralston