Commit Graph

6288 Commits (9b3f01b0193caa1e1c563cfc861ab021bcddcb2c)
 

Author SHA1 Message Date
Aaron Raimist 32ce58932f
Put back Typos CI (#3753)
Was removed in 161be7e7c0

Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
Germain 489f8d8544
MSC3440: Threading via `m.thread` relation (#3440)
* Threading  via  relation

* Add explainer on how to handle m.in_reply_to

* Clarify wording on threading MSC

* Mention MSC3051 in the alternative section of MSC3440

* Clarify updates to MSC2675 for MSC3440

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

* Line wrap the MSC

* More line wrapping for MSC3440

* Clarify single-layer event aggregation section

* Update thread-as-rooms advantages

* Clarify backwards compatibility and incremental support

* Clarify wording and correct typos

* Splitting Cerulean and MSC2836 in alternatives section

* Add dependencies for threads MSC

* Clarify intro to threads as rooms

* Add currentUserParticipated flag

* snake_case over camelCase

* Adding dependency to MSC3567

* Add threads capability

* Fix typo

* Update syntax highlighting to use jsonc

* Add limitations when fetching thread content by relation type

* Add reply chain fallback via m.in_reply_to

* Clarity in wording and fix typo

Co-authored-by: James Salter <jamess@element.io>
Co-authored-by: Matthew Hodgson <matthew@matrix.org>

* Cosmetic changes based on pull request feedback

* Add note to allow clients to omit fallback for rich replies

* fix typo

* Clarify wording to not confuse thread answers with quote-replies

* move relations justification to alternatives section

* Clarify handling of m.in_reply_to missing rel_type:m.thread

* Fix typo

* Fix typo

* Declare MSC2781 as a dependency

* Use rich reply over quote reply

* Depend on MSC3676 rather than MSC2781

Rather than relying on fallbacks being removed outright (and all the notification complications that causes in #2781), instead depend on #3676 which makes fallbacks best effort.

* Remove full stop typo

Co-authored-by: Erik Johnston <erik@matrix.org>

* Clarify new filtering parameters.

* Fix typo.

* Update wording for client side considerations

Co-authored-by: Hubert Chathi <hubertc@matrix.org>

* Add m.in_reply_to mixin to thread fallback

* Add guidance for clients and servers for thread invalid relations

* update thread root wording

* Add better definition to reply target event

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

* Add note regarding forward compatibility

* link to MSC2674

* Update proposals/3440-threading-via-relations.md

Co-authored-by: Hubert Chathi <hubertc@matrix.org>

* Clarification on responsibilities for the reply fallback

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

* Update `/messages` API endpoint version on example

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

* Apply wording suggestions from code review

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

* Add notes on server-side invalid relation filtering

* Fix typo

* reword paragraph about forwarding m.thread relation

* Add unstable prefix for capability endpoint

* Re-order alternatives to match intro paragraph

* rework relation_senders and relation_types definition

* Apply wording suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Kim Brose <kim.brose@rwth-aachen.de>

* Clarify fallback mechanism

* Rename filter property names

* Change m.render_in to m.display_reply_fallback

* Clarify what endpoints support the new filter

* Switch from /capabilities to /versions

* remove references to Cerulean

* Update latest_event description

* Clarity in wording and fix typo

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

* rename m.display_reply_fallback to hide_reply

* remove redundant paragraph about forward compat

* Improve bundled relationship example

* Explain context on why a thread-unaware client might want to send m.thread

* Clarify `hide_reply`

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

* Rename hide_reply to show_reply

* rename show_reply to is_falling_back

* Add note about stable support.

* Update proposals/3440-threading-via-relations.md

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

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Co-authored-by: James Salter <jamess@element.io>
Co-authored-by: Matthew Hodgson <matthew@matrix.org>
Co-authored-by: Erik Johnston <erik@matrix.org>
Co-authored-by: Patrick Cloke <patrickc@matrix.org>
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
Co-authored-by: Travis Ralston <travisr@matrix.org>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Kim Brose <kim.brose@rwth-aachen.de>
3 years ago
Tulir Asokan daf940a128 MSC3316: Add timestamp massaging to the spec (#3316)
* Proposal to add timestamp massaging to the spec

Signed-off-by: Tulir Asokan <tulir@maunium.net>

* Update unstable prefix

Signed-off-by: Tulir Asokan <tulir@maunium.net>
3 years ago
Richard van der Hoff 161be7e7c0 remove github magic irrelevant to matrix-spec-proposals 3 years ago
Richard van der Hoff b655688d30 Remove content unrelated to proposals 3 years ago
Andrew Morgan b26aa7fcf5
Remove 'room_id' field from `m.typing`, `m.receipt` and `m.fully_read` examples and schema (#3679)
The spec had an erroneous `room_id` field in a m.typing EDU entry of /sync, `m.read` receipts in `/sync`, and `m.fully_read` room account data objects in the spec. None of these are necessary nor used in practice.

Checking part of the ecosystem for whether clients look for, or homeservers include, these room_id fields, I found that:

    Element does not require them, nor does Synapse include them.
    Ruma does not include them.
    Dendrite does not include them.
    nheko/mtxclient does not look for them.

This change removes room_id from the example and OpenAPI schema in each case mentioned above. It only affects the Client-Server spec - the Server-Server spec text remains unchanged.

The field was initially introduced in 0f28f83.
3 years ago
Aaron Raimist 419d8cbd94
Update the default room version to 9 (#3739)
* Update the default room version to 9

Spec PR for [MSC3589](https://github.com/matrix-org/matrix-doc/pull/3589)

Signed-off-by: Aaron Raimist <aaron@raim.ist>

* Add changelog

Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
Aaron Raimist 2e63733beb
Remove unenforced size limit on room names (#3669)
Fixes #3641

The spec says the name field in m.room.name events must not exceed 255 bytes but no servers actually enforce this over the C-S API. Clients should probably already be truncating room names to an appropriate length for their user interface.

Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
Jonas Platte d7d52e8074
Fix broken link in end_to_end_encryption.md (#3708) 3 years ago
Alexandre Franke 1afbffb98e
Warn of untagged operations (#3699)
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Tulir Asokan be3b8e3a3c
Fix join membership auth rules when `join_rule` is knock (#3737)
Fixes #3736
3 years ago
Travis Ralston 7afac76e18
Fix membership state table and diagram (#3730)
* Fix membership state table and diagram

There were 2 missing cases which are legal:
* `invite->knock` (a fairly silly thing to do, but legal under the auth rules)
* `external->leave (via /kick)` (another somewhat silly thing to do, but no different than `external->ban (via /ban)`)

The state table considered the first as illegal, which is untrue.

* Changelog

* Make the graph prettier

* Update changelogs/client_server/newsfragments/3730.clarification

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
Travis Ralston 23b0e11409
MSC3589: Room version 9 as the default room version (#3589)
* Room version 9 as a default room version

* Update statistics and notes about maturity

* Adjust wording for Conduit

* Update to stable link
3 years ago
Hubert Chathi e9fed105c6
MSC3582: Remove m.room.message.feedback (#3582)
* proposal to remove m.room.message.feedback

* use MSC number
3 years ago
Travis Ralston 8851974d03
Another changelog fix (#3731) 3 years ago
Travis Ralston 8a0a799a4b
Clarify that the X-Matrix validation uses the parsed request body (#3727) 3 years ago
Richard van der Hoff 9e4b170643
Skip building the docs site for MSCs (#3729)
If only the `proposals` directory has changed, there's no point building the
docs site and offering a preview.
3 years ago
Travis Ralston 7aeea64797
Fix location of some changelogs (#3728)
They were seemingly put in the wrong place. They are only on unstable and do not affect a release.
3 years ago
Richard van der Hoff ca466b5a57
Attempt to clarify how `event_match` works (#3690)
Fixes #3082, #2637, #3075.
3 years ago
Will Hunt c420fc49a0
Fix m.login.appservice -> m.login.application_service (#3711)
* Fix m.login.appservice -> m.login.application_service

Implementations seem to agree with the proposal, so I'd suggest we fix the typo in the spec. I don't *think* this needs a MSC as the original proposal was fine, and this was just a copy error.

* Create 3711.clarification

* Update 3711.clarification

* Update changelogs/3711.clarification

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

Co-authored-by: Travis Ralston <travisr@matrix.org>
3 years ago
Richard van der Hoff f989d323c0
Update v1.2 changelog with missed PR (#3705) 3 years ago
Andrew Morgan 868949908c
Use `yaml.safe_load` in `check-swagger-sources.py` (#3719) 3 years ago
Andrew Morgan 0d634b1935
Use yaml.safe_load instead of yaml.load in `check-event-schema-examples.py` (#3716) 3 years ago
Hubert Chathi d06f05571f move changelog to the right place 3 years ago
Richard van der Hoff 1913812a90
Clarify send_join response (#3703) 3 years ago
Andrew Morgan e7adfd5ed1
Fix missed rst->md numbered list syntax for `m.room.server_acl` (#3681)
* Fix missed rst->md numbered list syntax
3 years ago
Richard van der Hoff c400dc99c0
Update dependencies (#3707)
https://github.com/advisories/GHSA-566m-qj78-rww5 is a thing. I don't think
it's directly relevant to us, but upgrading is good.
3 years ago
Travis Ralston 956a22da11 return to unstable 3 years ago
Travis Ralston e488a7fb6d v1.2 changelog 3 years ago
Travis Ralston 4b78d22e8c release steps: fastforward main 3 years ago
Travis Ralston fb2aa688db prep for v1.2 3 years ago
Alexandre Franke de9cf76a57
Dump additional apis (#3684)
*  Allow JSON generation for all API

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 👷 Export AS API JSON

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

*  Handle missing security definitions

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 👷 Export Push Gateway API JSON

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 🎨 Improve identation

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 🐛 Fix successive reference handling

Fixes #3689

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 👷 Export Server-Server API JSON

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 📝 Remove obsolete comment

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* 🐛 Make properties objects, as they MUST be

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>

* Revert "👷 Export Server-Server API JSON"

This reverts commit 061f91c2cb.

Co-authored-by: Alexandre Franke <alexandre.franke@matrix.org>
3 years ago
Travis Ralston 0f9eadd1a1
Fix knock->leave transition in auth rules (#3694)
* Fix knock->leave transition in auth rules

This was an oversight from knocking being added.

For safety, this has been verified as at least intended by Synapse to work:
f5e2cde3f5/synapse/event_auth.py (L390-L391)

* changelog
3 years ago
Matthew Hodgson 2cd2a7122c
MSC3676: Transitioning away from reply fallbacks (#3676)
* MSC3676: Transitioning away from reply fallbacks

* msc number

* md fails

* typoe

* Update proposals/3676-transitioning-away-from-reply-fallbacks.md

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

* incorporate feedback

* consolidate justification

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
3 years ago
devonh dd32431b85
Fix broken link in server-server signing events section (#3528)
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
3 years ago
devonh fc5ba959ca
Separate PDU terms from their definitions (#3527)
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
3 years ago
Richard van der Hoff 36b02edfc2
Distinguish 'client' from 'federation' events (#3658)
Fixes #3305 
Fixes #3380
 
The idea here is to better distinguish between a 'raw' event (as we send over the wire), and the 
'serialised' format, as sent in responses to the C-S api and in `PUT /_matrix/app/v1/transactions/{txnId}`.

It's made more complicated by the fact that there are _two_ serialisation formats, one used by `/sync`
and `/notifications`, and one by everything else (the difference being whether `room_id` is included).

In an ideal world, we wouldn't repeat `SerialisedEvent` every time it's used, and instead just link to the
first reference, but that's a job for another day.

Another job for another day is to get rid of things like `sync_state_event.yaml` (which is now used
only in one place, so should be inlined.)
3 years ago
Travis Ralston d4c74d37a9
Update documentation style & fix room version heading order (#3683)
* Update documentation style & fix room version heading order

Also add a missing signing key section to v6.

This additionally contains various edits to the fragments to have them make a little bit more sense in context.

Finally, this updates various aspects of the documentation style which haven't previously been considered - they're added here considering we're in the area.

* changelog

* enhanced changelogs

* Minor wording adjustments

* Apply suggestions from code review

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
Aaron Raimist 990dfec94b
Update several spots where C-S API was still using r0 APIs (#3671)
* Update several spots where C-S API was still using r0 APIs

Signed-off-by: Aaron Raimist <aaron@raim.ist>

* Add changelog

Signed-off-by: Aaron Raimist <aaron@raim.ist>
3 years ago
Alexandre Franke d3e39567f4
Responses schema fixes (#3650)
Fixes #2237.

Corrects the response schemas for:

```
PUT /user/{user_id}/account_data/{account_dataType}
PUT /user/{user_id}/rooms/{roomId}/account_data/{type}
PUT /directory/list/room/{roomId}
PUT /sendToDevice/{eventType}/{txnId}
POST /account/3pid
POST /account/3pid/add
POST /account/3pid/bind
```
3 years ago
Travis Ralston 2e5cc42666
Update node-fetch dependency & lockfile version (#3670)
Modern versions of node and npm should be compatible with this format.

Supersedes https://github.com/matrix-org/matrix-doc/pull/3668
3 years ago
Travis Ralston df1d150142 Add missing changelog 3 years ago
Travis Ralston 59f4d7ffed Revert fix to appendices 3 years ago
Matthew Hodgson 20aa44bd13
typoes (#3680)
* typoes

* Appease the faulty spellcheck on the json too

Co-authored-by: Travis Ralston <travisr@matrix.org>
3 years ago
Richard van der Hoff 4a9c236572 Changelogs for #3674 3 years ago
Richard van der Hoff c3b53d5ae6
comments on resolve-allof (#3657) 3 years ago
Richard van der Hoff 783624d2cd
Fix rendering of responses with empty bodies (#3674) 3 years ago
Richard van der Hoff 39a41a18ba
Fix the response for `GET /_matrix/app/v1/thirdparty/protocol/{protocol}` (#3675)
This should return a single protocol, not all of them.

Fixes #2286.
3 years ago
Matthew Hodgson c151353956 s/master/main/g otherwise we link to stale content 3 years ago
Travis Ralston 4a597ace51
Re-add knock's `otherwise, reject` per MSC2403 (#3661)
* Re-add knock's `otherwise, reject` per MSC2403

Fixes https://github.com/matrix-org/matrix-doc/issues/3648

* changelog + changelog for 3432
3 years ago