wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Clarification for /event_auth (#3583)

Browse source 
The description on this endpoint implied it returned the auth chain for the
full state of the room, which is incorrect.
This commit is contained in:
Richard van der Hoff 2022-01-04 16:45:10 +00:00 • committed by GitHub
parent 592cbd537c
commit 355e06eaa6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/server_server/newsfragments/3583.clarification Normal file
View file

@ -0,0 +1 @@
Clarify that `GET /_matrix/federation/v1/event_auth/{roomId}/{eventId}` does *not* return the auth chain for the full state of the room.

12
data/api/server-server/event_auth.yaml
View file

@ -57,17 +57,13 @@ paths:
auth_chain: auth_chain:
type: array type: array
description: |- description: |-
The full set of authorization events that make up the state of The [PDUs](/server-server-api/#pdus) forming the auth chain
the room, and their authorization events, recursively. Note that of the given event. The event format varies depending on the
events have a different format depending on the room version - room version - check the [room version specification](/rooms)
check the [room version specification](/rooms) for precise event formats. for precise event formats.
items: items:
type: object type: object
title: PDU title: PDU
description: |-
The [PDUs](/server-server-api/#pdus) contained in the auth chain. The event format
varies depending on the room version - check the [room version specification](/rooms)
for precise event formats.
properties: [] properties: []
example: example:
$ref: "examples/minimal_pdu.json" $ref: "examples/minimal_pdu.json"