Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-02 04:23:42 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clarify history of endpoint.

Browse source
This commit is contained in:
Patrick Cloke 2020-03-03 13:15:32 -05:00
parent 420180a69d
commit c3420770ad
1 changed files with 23 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
proposals/xxxx-remove-query_auth-federation-endpoint.md
View file

@ -1,26 +1,39 @@
# MSCxxxx: Remove the `query_auth` federation endpoint
The `query_auth` federation endpoint is unused by Synapse and should be removed.
The current implementation in Synapse is broken and will return a 500 error in
some situations.
The current implementation in Synapse is not robust and will return a 500 error
in some situations.
## Proposal
Remove:
Remove the following endpoint:
* [POST `/_matrix/federation/v1/query_auth/{roomId}/{eventId}`](https://matrix.org/docs/spec/server_server/r0.1.3#post-matrix-federation-v1-query-auth-roomid-eventid)
## Potential issues
Removing this endpoint impacts backwards compatibility.
Removing this endpoint impacts backwards compatibility, in practice removing
this endpoint should have minimal impact as it was an unused error path in
Synapse. The federation client code to call this endpoint was removed in Synapse
v1.5.0rc1.
Note that dendrite has never implemented this federation endpoint.
### History
This endpoint (and the federation client code) to call it was initially
added in Synapse v0.7.0 (see [#43](https://github.com/matrix-org/synapse/pull/43)).
The federation client code was heavily modified for v1.0.0rc1 (see
[#5227](https://github.com/matrix-org/synapse/pull/5227/)),
The federation client code to call this endpoint was removed in v1.5.0rc1 of
Synapse (see [#6214](https://github.com/matrix-org/synapse/pull/6214). After
that point this endpoint is not called).
In practice, removing this endpoint should have minimal impact. Since 1.5.0rc1
of Synapse this endpoint is not called (see [#6214](https://github.com/matrix-org/synapse/pull/6214)).
During removal it was noted that the code to call this endpoint was already
unreachable.
Note that it seems like this was initially supported in Synapse v0.7.0. It is
not clear at what point it became unused.
unreachable. It seems that this code was never reachable and was meant for an
error situation which was never built out (see `git log -S NOT_ANCESTOR`, the
error condition is never assigned).
## Alternatives