docs-matrix-spec/changelogs
Andrew Morgan 8a5955e98f 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.
2022-05-09 01:28:17 -06:00
..
appendices/newsfragments v1.2 changelog 2022-02-02 10:05:30 -07:00
application_service/newsfragments v1.2 changelog 2022-02-02 10:05:30 -07:00
client_server/newsfragments Remove 'room_id' field from m.typing, m.receipt and m.fully_read examples and schema (#3679) 2022-05-09 01:28:17 -06:00
identity_service/newsfragments v1.2 changelog 2022-02-02 10:05:30 -07:00
legacy Add GitHub Action to check spelling (#3591) 2021-12-28 09:17:49 -07:00
push_gateway/newsfragments v1.2 changelog 2022-02-02 10:05:30 -07:00
room_versions Update the default room version to 9 (#3739) 2022-05-09 01:28:17 -06:00
server_server/newsfragments Clarify that the X-Matrix validation uses the parsed request body (#3727) 2022-05-09 01:28:17 -06:00
header.md Fix broken links to matrix-doc (#1032) 2022-04-20 16:36:14 +01:00
pyproject.toml Fix broken links to matrix-doc (#1032) 2022-04-20 16:36:14 +01:00
README.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00

Changelogs

Towncrier is used to manage the changelog and keep it up to date. Because of this, updating a changelog is really easy.

Generating the changelog

Please see the release docs for more information.

Creating a new changelog

There are a few places you'll have to update:

  • /layouts/shortcodes/changelog/changelog-changes.html to account for the new changelog.
  • /scripts/generate-changelog.sh to render the changelog for releases.
  • Supporting documentation such as the contributing guidelines.