matrix-spec/changelogs
Olivia Lee 9bbb9c5397
move standard error schema to appendices and share between all APIs
I asked about this on matrix, and tulir confirmed[1] that the error
schema was intended to be shared between all APIs. I would like the
shared schema to be explicit in the spec text so that ruma can move to
using the same error type for client-server and server-server endpoints.
This would simplify error handling in server implementations.

Error codes that are used in more than one API were moved to the
appendices, while error codes specific to only one API were left there.
Since the docs on which error codes are actually used by which endpoints
aren't very complemete, I determined this by looking at the synapse
source code.

[1]: https://matrix.to/#/#matrix-spec-discussion:neko.dev/$Y2yTCeR_AeW6g_4jViFbx4gTE_AwF0RN7yrHJ25F5Q8

Signed-off-by: Olivia Lee <olivia@computer.surgery>
2024-12-13 00:27:51 -08:00
..
appendices/newsfragments move standard error schema to appendices and share between all APIs 2024-12-13 00:27:51 -08:00
application_service/newsfragments move standard error schema to appendices and share between all APIs 2024-12-13 00:27:51 -08:00
client_server/newsfragments move standard error schema to appendices and share between all APIs 2024-12-13 00:27:51 -08:00
identity_service/newsfragments move standard error schema to appendices and share between all APIs 2024-12-13 00:27:51 -08:00
internal/newsfragments Change the accessible role of info boxes to note (#2022) 2024-12-10 22:59:29 +00:00
legacy Add a hyphen between third and party when used as an adjective (#1447) 2023-03-08 09:58:29 +00:00
push_gateway/newsfragments move standard error schema to appendices and share between all APIs 2024-12-13 00:27:51 -08:00
room_versions/newsfragments Clarify rule 4.3.1 of the auth rules in room version 11 (#2024) 2024-12-04 11:40:27 -05:00
server_server/newsfragments Add spec for MSC4163: Make ACLs apply to EDUs (#2004) 2024-12-11 22:48:04 +00:00
header.md Fix relative URLs when serving the specification with a custom baseURL (#1984) 2024-11-14 11:11:34 +00:00
pyproject.toml Fix rendered changelog with new version of towncrier (#1598) 2023-07-18 17:52:38 +01:00
README.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
template.md.jinja Provide MD checklists for the changelog (#1937) 2024-09-27 13:00:00 +01: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.