Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
Co-authored-by: Travis Ralston <travisr@matrix.org>
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.
* Add a release branch to avoid orphaned commits.
* Specify a patch process.
* Match reality and reference the internal deployment process.
This is largely what we do in practice now, including a created `release/v1.1` branch.
Switch to upstream and use a more recent version.
Fixes failure to edit on empty descriptions.
Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
* MSC3419 - Guest state events
Let guests send state events. Needed for guests to work with native
group voip in #3401
* typo
* Update 3419-guest-state-events.md
incorporate @clokep clarification
* also let guests send non-m.room.message events in general.
* Update proposals/3419-guest-state-events.md
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Update proposals/3419-guest-state-events.md
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* wordwrap
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
The documentation for the `/notifications` API had its own special definition
of what an Event was, which was used nowhere else.
The common definition isn't perfect, but it *is* common, so it gives us a
better starting place for improvement.
* 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>
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.
* initial version of event relationship MSC
* fix MSC numbers
* clarifications
* mention multiple relations per event might be useful, but postpone for a future MSC
* mention MSC 3051 for proposed multiple relations
* remove send_relation endpoint
* move e2ee section under sending relations
* mention limitation of leaving server-side aggregations out for now
* remove mentions of m.reference, we'll sort that out in another MSC
* whitespace
* argument why m.relates_to should be preserved by redactions more general
but still give example of redacted edits
* deal with this in the comments
* clarify the conditions to meet for a relation
* mention specifically that this does not replace replies (yet)
* clarify how general rel_types should be
* clarify that gaps may cause clients to be unaware of some relations
* Update proposals/2674-event-relationships.md
Co-authored-by: DeepBlueV7.X <nicolas.werner@hotmail.de>
* Update proposals/2674-event-relationships.md
Co-authored-by: DeepBlueV7.X <nicolas.werner@hotmail.de>
* make wording clearer and move to bottom of section
* remove this as references are not defined here anymore
* clearer wording
* move edge cases to other relevant mscs
* clarify that a goal of sticking to this format is backwards compat.
* mention MSC 3267, to which m.reference has been extracted
* Update proposals/2674-event-relationships.md
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
* Update proposals/2674-event-relationships.md
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
* Update proposals/2674-event-relationships.md
Co-authored-by: Matthew Hodgson <matthew@arasphere.net>
* Update proposals/2674-event-relationships.md
Co-authored-by: Matthew Hodgson <matthew@arasphere.net>
* Update proposals/2674-event-relationships.md
Co-authored-by: Travis Ralston <travpc@gmail.com>
* wrap lines
* better wording
* this is singular, really
* add example of event shape
* specify how invalid relations should be treated by the redaction algorithm
* fix typo
* split up redactions changes in separate MSC
* also add new msc to introduction
* reword why not adopt m.in_reply_to
* remove guidelines how to pick rel_type
* mention that the target event must exist in the same room
* spell out the conscious (subject, object, verb) triple idea.
* Spelling
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* remove paragraph saying what server should accept
* Revert "remove paragraph saying what server should accept"
This reverts commit e0271331b2e7dee236349aa63eec3cec7369e361.
* further specify that a server should reject invalid relations through the cs api
* linebreak
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Bruno Windels <bruno@windels.cloud>
Co-authored-by: DeepBlueV7.X <nicolas.werner@hotmail.de>
Co-authored-by: Matthew Hodgson <matthew@arasphere.net>
Co-authored-by: Travis Ralston <travpc@gmail.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
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.
The entries were text-less and not really helping anyone. They are included as pages because we need them for templating, but we don't need people to be able to land on them directly.
* 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.
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#3156fixes#2189
Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
* Fully specify room versions
* Misc typo clarifications
* Try to clarify redactions a bit
* Update content/client-server-api/_index.md
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Update content/rooms/v6.md
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Update content/rooms/v6.md
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Better describe client considerations
* Doc template params
* Move redaction "new stuff" to v3
* Remove unhelpful sentences about "here follows unchanged stuff"
* Simplify event signing text
* Clean up handling redactions sections
* Move v4's event schema to unchanged section
* Update content/rooms/v4.md
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>
* Spaces Summary
* MSC2946
* Clarity
* More clarity
* Clarify what no room data means for clients
* Federation API
* Update 2946-spaces-summary.md
* auto_join filter
* Blurb on auth for fed api
* Update to reflect MSC1772 changes
* Mention auth chain on federation api
* Add 'version' field
* Stripped state; remove room versions
* Update 2946-spaces-summary.md
* Update proposals/2946-spaces-summary.md
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Replace with link to draft doc.
* Add a preamble and copy the current draft API.
* Switch to using stable identifiers (and add an unstable identifiers section).
* Updates / clarifications.
* Fix typo.
* Clean-ups.
* Update proposals/2946-spaces-summary.md
Co-authored-by: Travis Ralston <travpc@gmail.com>
* Drop unstable identifiers from MSC1772.
* Various updates and clarifications.
* Include the origin_server_ts in the response, as needed by MSC1772.
* Rename a parameter for clarity.
* Fix typo.
Co-authored-by: David Baker <dbkr@users.noreply.github.com>
* Various clarifications based on feedback.
* Add auth / rate-limiting info.
* Combine some double spaces.
* Use only GET endpoints.
* Add notes about DoS potential.
* Tweaks from review.
* Add context about why stripped events are returned.
* Remove some implementation details.
* Add notes on ordering.
* Remove unnecessary data.
* Clarify the server-server API.
* More clarifications.
* Remove obsolete note.
* Some clarifications to what accessible means.
* Update notes about sorting to include the origin_server_ts of the m.space.child event.
This reverts commit af8c7b04d9f87bb2c4292a549b7db36ae6ef2324.
* Only consider `m.space` rooms and do not return links to nowhere.
* Updates based on MSC3173 merging and updates to MSC3083.
* Updates per MSC2403.
* Remove field which is not part of the C-S API.
* Rewrite the proposal.
* Handle todo comments.
* Update URLs.
* Rename field.
* Updates based on implementation.
* Clarify the state which is persisted.
* Expand notes about errors.
* Update MSC with pagination parameter.
* Fix wrong endpoint.
Co-authored-by: Matthew Hodgson <matthew@matrix.org>
* Clarifications based on implementation.
* Remove empty section.
* Fix typo.
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Rename field in example.
* Clarify error code.
* Clarify ordering changes.
* Clarify wording.
Co-authored-by: Travis Ralston <travisr@matrix.org>
* Fix typos.
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
* Clarify that rooms do not belong to servers.
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
* Fix example to use correct URL.
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
* Clarify using local vs. remote data.
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
* Clarify bits aboud stripped state.
* Clarify access control of federation responses.
* Clarify error code.
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
* Be less prescriptive about expiring data.
* Limit must be non-zero.
Co-authored-by: Travis Ralston <travisr@matrix.org>
* Rate limiting.
Co-authored-by: Travis Ralston <travisr@matrix.org>
* Add a note about room upgrades.
* Update stable URLs per MSC2844.
* Clarify federation return values.
* Clarify `origin_server_ts`.
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Tweak wording around `inaccessible_children`.
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <richard@matrix.org>
Co-authored-by: Patrick Cloke <patrickc@matrix.org>
Co-authored-by: Matthew Hodgson <matthew@matrix.org>
Co-authored-by: Travis Ralston <travpc@gmail.com>
Co-authored-by: David Baker <dbkr@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Travis Ralston <travisr@matrix.org>
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Alexandre Franke