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

Move room version spec to /rooms (#3423)

Browse source 
* Cut/paste room version spec to its own page

* Move grammar to bottom + add feature matrix

The version grammar is not as interesting as the actual room versions, so this moves that whole section to the bottom.

* Fix all links to room versions
This commit is contained in:
Travis Ralston 2021-10-12 14:47:03 -06:00 • committed by GitHub
parent f295e828dc
commit 649fc2bdd2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 152 additions and 145 deletions
Download patch file Download diff file Expand all files Collapse all files

2
data/api/server-server/backfill.yaml
View file

@ -130,7 +130,7 @@ paths:
type: array
description: |-
The missing events. The event format varies depending on the room version - check
the [room version specification](/#room-versions) for precise event formats.
the [room version specification](/rooms) for precise event formats.
items:
type: object
title: PDU

2
data/api/server-server/definitions/invite_event.yaml
View file

@ -15,7 +15,7 @@ type: object
title: InviteEvent
description: |-
An invite event. Note that events have a different format depending on the
room version - check the [room version specification](/#room-versions) for precise event formats.
room version - check the [room version specification](/rooms) for precise event formats.
allOf:
- type: object
properties:

2
data/api/server-server/definitions/keys.yaml
View file

@ -90,7 +90,7 @@ properties:
description: |-
POSIX timestamp when the list of valid keys should be refreshed. This field MUST
be ignored in room versions 1, 2, 3, and 4. Keys used beyond this timestamp MUST
be considered invalid, depending on the [room version specification](/#room-versions).
be considered invalid, depending on the [room version specification](/rooms).
Servers MUST use the lesser of this field and 7 days into the future when
determining if a key is valid. This is to avoid a situation where an attacker

8
data/api/server-server/definitions/send_join_response.yaml
View file

@ -25,13 +25,13 @@ properties:
The auth chain for the entire current room state prior to the join event.
Note that events have a different format depending on the room version - check the
[room version specification](/#room-versions) for precise event formats.
[room version specification](/rooms) for precise event formats.
items:
type: object
title: PDU
description: |-
The [PDUs](/server-server-api/#pdus) that make up the auth chain. The event format varies depending
on the room version - check the [room version specification](/#room-versions) for precise event formats.
on the room version - check the [room version specification](/rooms) for precise event formats.
schema:
type: object
properties: []
@ -42,14 +42,14 @@ properties:
description: |-
The resolved current room state prior to the join event.
The event format varies depending on the room version - check the [room version specification](/#room-versions)
The event format varies depending on the room version - check the [room version specification](/rooms)
for precise event formats.
items:
type: object
title: PDU
description: |-
The [PDUs](/server-server-api/#pdus) for the fully resolved state of the room. The event format varies depending
on the room version - check the [room version specification](/#room-versions) for precise event formats.
on the room version - check the [room version specification](/rooms) for precise event formats.
schema:
type: object
properties: []

4
data/api/server-server/definitions/single_pdu_transaction.yaml
View file

@ -19,13 +19,13 @@ properties:
type: array
description: |-
A single PDU. Note that events have a different format depending on the room
version - check the [room version specification](/#room-versions) for precise event formats.
version - check the [room version specification](/rooms) for precise event formats.
items:
type: object
title: PDU
description: |-
The [PDUs](/server-server-api/#pdus) contained in the transaction. The event format varies depending
on the room version - check the [room version specification](/#room-versions) for precise event formats.
on the room version - check the [room version specification](/rooms) for precise event formats.
properties: []
example:
$ref: "../examples/minimal_pdu.json"

4
data/api/server-server/definitions/transaction.yaml
View file

@ -34,13 +34,13 @@ properties:
description: |-
List of persistent updates to rooms. Must not include more than 50 PDUs. Note that
events have a different format depending on the room version - check the
[room version specification](/#room-versions) for precise event formats.
[room version specification](/rooms) for precise event formats.
items:
type: object
title: PDU
description: |-
The [PDUs](/server-server-api/#pdus) contained in the transaction. The event format varies depending
on the room version - check the [room version specification](/#room-versions) for precise event formats.
on the room version - check the [room version specification](/rooms) for precise event formats.
properties: []
example:
$ref: "../examples/minimal_pdu.json"

4
data/api/server-server/definitions/unlimited_pdu_transaction.yaml
View file

@ -19,14 +19,14 @@ properties:
type: array
description: |-
List of persistent updates to rooms. Note that events have a different format
depending on the room version - check the [room version specification](/#room-versions) for
depending on the room version - check the [room version specification](/rooms) for
precise event formats.
items:
type: object
title: PDU
description: |-
The [PDUs](/server-server-api/#pdus) contained in the transaction. The event format varies depending
on the room version - check the [room version specification](/#room-versions) for precise event formats.
on the room version - check the [room version specification](/rooms) for precise event formats.
properties: []
example:
$ref: "../examples/minimal_pdu.json"

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

@ -60,13 +60,13 @@ paths:
The full set of authorization events that make up the state of
the room, and their authorization events, recursively. Note that
events have a different format depending on the room version -
check the [room version specification](/#room-versions) for precise event formats.
check the [room version specification](/rooms) for precise event formats.
items:
type: object
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](/#room-versions)
varies depending on the room version - check the [room version specification](/rooms)
for precise event formats.
properties: []
example:

8
data/api/server-server/events.yaml
View file

@ -61,13 +61,13 @@ paths:
The full set of authorization events that make up the state
of the room, and their authorization events, recursively. Note that
events have a different format depending on the room version -
check the [room version specification](/#room-versions) for precise event formats.
check the [room version specification](/rooms) for precise event formats.
items:
type: object
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](/#room-versions)
varies depending on the room version - check the [room version specification](/rooms)
for precise event formats.
properties: []
example:
@ -77,13 +77,13 @@ paths:
description: |-
The fully resolved state of the room at the given event. Note that
events have a different format depending on the room version -
check the [room version specification](/#room-versions) for precise event formats.
check the [room version specification](/rooms) for precise event formats.
items:
type: object
title: PDU
description: |-
The [PDUs](/server-server-api/#pdus) for the fully resolved state of the room. The event format
varies depending on the room version - check the [room version specification](/#room-versions)
varies depending on the room version - check the [room version specification](/rooms)
for precise event formats.
properties: []
example:

4
data/api/server-server/invites-v1.yaml
View file

@ -40,7 +40,7 @@ paths:
or `"2"`.
Note that events have a different format depending on the room version - check the
[room version specification](/#room-versions) for precise event formats. **The request and response
[room version specification](/rooms) for precise event formats. **The request and response
bodies here describe the common event fields in more detail and may be missing other
required fields for a PDU.**
operationId: sendInviteV1
@ -106,7 +106,7 @@ paths:
description: |-
The event with the invited server's signature added. All other fields of the events
should remain untouched. Note that events have a different format depending on the
room version - check the [room version specification](/#room-versions) for precise event formats.
room version - check the [room version specification](/rooms) for precise event formats.
schema:
type: array
minItems: 2

4
data/api/server-server/invites-v2.yaml
View file

@ -44,7 +44,7 @@ paths:
API as the server may be older, if the room version is "1" or "2".
Note that events have a different format depending on the room version - check the
[room version specification](/#room-versions) for precise event formats. **The request and response
[room version specification](/rooms) for precise event formats. **The request and response
bodies here describe the common event fields in more detail and may be missing other
required fields for a PDU.**
operationId: sendInviteV2
@ -111,7 +111,7 @@ paths:
description: |-
The event with the invited server's signature added. All other fields of the events
should remain untouched. Note that events have a different format depending on the
room version - check the [room version specification](/#room-versions) for precise event formats.
room version - check the [room version specification](/rooms) for precise event formats.
schema:
type: object
description: An object containing the signed invite event.

6
data/api/server-server/joins-v1.yaml
View file

@ -64,7 +64,7 @@ paths:
description: |-
A template to be used for the rest of the [Joining Rooms](/server-server-api/#joining-rooms) handshake. Note that
events have a different format depending on the room version - check the
[room version specification](/#room-versions) for precise event formats. **The response body
[room version specification](/rooms) for precise event formats. **The response body
here describes the common event fields in more detail and may be missing other
required fields for a PDU.**
schema:
@ -79,7 +79,7 @@ paths:
event:
description: |-
An unsigned template event. Note that events have a different format
depending on the room version - check the [room version specification](/#room-versions)
depending on the room version - check the [room version specification](/rooms)
for precise event formats.
type: object
title: Event Template
@ -182,7 +182,7 @@ paths:
Submits a signed join event to the resident server for it
to accept it into the room's graph. Note that events have
a different format depending on the room version - check
the [room version specification](/#room-versions) for precise event formats.
the [room version specification](/rooms) for precise event formats.
**The request and response body here describe the common
event fields in more detail and may be missing other required
fields for a PDU.**

2
data/api/server-server/joins-v2.yaml
View file

@ -45,7 +45,7 @@ paths:
Submits a signed join event to the resident server for it
to accept it into the room's graph. Note that events have
a different format depending on the room version - check
the [room version specification](/#room-versions) for precise event formats.
the [room version specification](/rooms) for precise event formats.
**The request and response body here describe the common
event fields in more detail and may be missing other required
fields for a PDU.**

6
data/api/server-server/knocks.yaml
View file

@ -63,7 +63,7 @@ paths:
description: |-
A template to be used for the rest of the [Knocking Rooms](/server-server-api/#knocking-rooms)
handshake. Note that events have a different format depending on room version - check the
[room version specification](/#room-versions) for precise event formats. **The response body
[room version specification](/rooms) for precise event formats. **The response body
here describes the common event fields in more detail and may be missing other
required fields for a PDU.**
schema:
@ -77,7 +77,7 @@ paths:
event:
description: |-
An unsigned template event. Note that events have a different format
depending on the room version - check the [room version specification](/#room-versions)
depending on the room version - check the [room version specification](/rooms)
for precise event formats.
type: object
title: Event Template
@ -195,7 +195,7 @@ paths:
Submits a signed knock event to the resident server for it to
accept into the room's graph. Note that events have
a different format depending on the room version - check
the [room version specification](/#room-versions) for precise event formats.
the [room version specification](/rooms) for precise event formats.
**The request and response body here describe the common
event fields in more detail and may be missing other required
fields for a PDU.**

6
data/api/server-server/leaving-v1.yaml
View file

@ -55,7 +55,7 @@ paths:
description: |-
A template to be used to call `/send_leave`. Note that
events have a different format depending on the room version - check the
[room version specification](/#room-versions) for precise event formats. **The response body
[room version specification](/rooms) for precise event formats. **The response body
here describes the common event fields in more detail and may be missing other
required fields for a PDU.**
schema:
@ -70,7 +70,7 @@ paths:
event:
description: |-
An unsigned template event. Note that events have a different format
depending on the room version - check the [room version specification](/#room-versions)
depending on the room version - check the [room version specification](/rooms)
for precise event formats.
type: object
title: Event Template
@ -149,7 +149,7 @@ paths:
Submits a signed leave event to the resident server for it
to accept it into the room's graph. Note that events have
a different format depending on the room version - check
the [room version specification](/#room-versions) for precise event formats.
the [room version specification](/rooms) for precise event formats.
**The request and response body here describe the common
event fields in more detail and may be missing other required
fields for a PDU.**

2
data/api/server-server/leaving-v2.yaml
View file

@ -45,7 +45,7 @@ paths:
Submits a signed leave event to the resident server for it
to accept it into the room's graph. Note that events have
a different format depending on the room version - check
the [room version specification](/#room-versions) for precise event formats.
the [room version specification](/rooms) for precise event formats.
**The request and response body here describe the common
event fields in more detail and may be missing other required
fields for a PDU.**

2
data/api/server-server/transactions.yaml
View file

@ -39,7 +39,7 @@ paths:
transaction with a different `txnId` to the receiving server.
Note that events have a different format depending on the room version - check
the [room version specification](/#room-versions) for precise event formats.
the [room version specification](/rooms) for precise event formats.
operationId: sendTransaction
security:
- signedRequest: []