Remove query_auth from the specification per MSC2451.

api/server-server/event_auth.yaml

@@ -72,137 +72,3 @@ paths:
  example:
  $ref: "examples/minimal_pdu.json"
  required: ['auth_chain']
- "/query_auth/{roomId}/{eventId}":
- post:
- summary: Compare auth chains with the receiving server
- description: |-
- Compares the auth chain provided with what the receiving server has for the
- room ID and event ID combination.
-
- The auth difference can be calculated in two parts, where the "remote auth"
- is the auth chain provided by the sending server and the "local auth" is the
- auth chain the receiving server has. With those lists, the algorithm works
- bottom-up after sorting each chain by depth then by event ID. The differences
- are then discovered and returned as the response to this API call.
- operationId: compareEventAuth
- security:
- - signedRequest: []
- parameters:
- - in: path
- name: roomId
- type: string
- description: The room ID to compare the auth chain in.
- required: true
- x-example: "!abc123:matrix.org"
- - in: path
- name: eventId
- type: string
- description: The event ID to compare the auth chain of.
- required: true
- x-example: "$helloworld:example.org"
- - in: body
- name: body
- schema:
- type: object
- properties:
- auth_chain:
- type: array
- description: |-
- The auth chain (the "remote auth"). Note that events have a different
- format depending on the room version - check the `room version specification`_
- for precise event formats.
- items:
- type: object
- title: PDU
- description: |-
- The `PDUs <#pdus>`_ contained in the auth chain. The event format
- varies depending on the room version - check the `room version specification`_
- for precise event formats.
- properties: []
- example:
- $ref: "examples/minimal_pdu.json"
- missing:
- type: array
- description: |-
- A list of event IDs that the sender thinks the receiver is missing.
- items:
- type: string
- example: []
- rejects:
- type: object
- description: |-
- The set of events that the sending server has rejected from the provided
- auth chain.
-
- The ``string`` key is the event ID that was rejected.
- additionalProperties:
- type: object
- title: Rejection Reason
- properties:
- reason:
- type: enum
- enum: ['auth_error', 'replaced', 'not_ancestor']
- description: |-
- The reason for the event being rejected.
- required: ['reason']
- example: {
- "$some_event:example.org": {
- "reason": "auth_error"
- }
- }
- required: ['auth_chain']
- responses:
- 200:
- description: The auth chain differences, as determined by the receiver.
- schema:
- type: object
- properties:
- auth_chain:
- type: array
- description: |-
- The auth chain the receiver has, and used to determine the auth
- chain differences (the "local auth"). Note that events have a different
- format depending on the room version - check the `room version specification`_
- for precise event formats.
- items:
- type: object
- title: PDU
- description: |-
- The `PDUs <#pdus>`_ contained in the auth chain. The event format
- varies depending on the room version - check the `room version specification`_
- for precise event formats.
- properties: []
- example:
- $ref: "examples/minimal_pdu.json"
- missing:
- type: array
- description: |-
- The list of event IDs that the receiver believes it is missing,
- after comparing the "remote auth" and "local auth" chains.
- items:
- type: string
- example: ["$a_missing_event:example.org"]
- rejects:
- type: object
- description: |-
- The set of events that the receiving server has rejected from the
- auth chain, not including events that the sending server is missing
- as determined from the difference algorithm.
-
- The ``string`` key is the event ID that was rejected.
- additionalProperties:
- type: object
- title: Rejection Reason
- properties:
- reason:
- type: enum
- enum: ['auth_error', 'replaced', 'not_ancestor']
- description: |-
- The reason for the event being rejected.
- required: ['reason']
- example: {
- "$some_event:example.org": {
- "reason": "auth_error"
- }
- }
- required: ['auth_chain', 'missing', 'rejects']

changelogs/server_server/newsfragments/2470.removal

@@ -0,0 +1 @@
+Remove the unused ``query_auth`` API per `MSC2451 <https:/matrix-org/matrix-doc/pull/2451>`_.

specification/server_server_api.rst

@@ -1077,7 +1077,6 @@ The following endpoint prefixes MUST be protected:
 * ``/_matrix/federation/v1/state_ids``
 * ``/_matrix/federation/v1/backfill``
 * ``/_matrix/federation/v1/event_auth``
-* ``/_matrix/federation/v1/query_auth``
 * ``/_matrix/federation/v1/get_missing_events``