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

Fix links in data

Browse source
This commit is contained in:
Will 2021-01-28 16:00:39 -08:00 • committed by Richard van der Hoff
parent 27f8867aa0
commit 873e8b30eb
84 changed files with 211 additions and 220 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`_ for precise event formats.
the [room version specification](/#room-versions) for precise event formats.
items:
type: object
title: PDU

4
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`_ for precise event formats.
room version - check the [room version specification](/#room-versions) for precise event formats.
allOf:
- type: object
properties:
@ -46,7 +46,7 @@ allOf:
title: Membership Event Content
description: |-
The content of the event, matching what is available in the
`Client-Server API`_. Must include a `membership` of `invite`.
[Client-Server API](/client-server-api/). Must include a `membership` of `invite`.
example: {"membership": "invite"}
properties:
membership:

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

@ -41,7 +41,7 @@ properties:
properties:
key:
type: string
description: The `Unpadded Base64`_ encoded key.
description: The [Unpadded base64](/appendices/#unpadded-base64) encoded key.
example: "VGhpcyBzaG91bGQgYmUgYSByZWFsIGVkMjU1MTkgcGF5bG9hZA"
required: ["key"]
old_verify_keys:
@ -70,7 +70,7 @@ properties:
example: 1532645052628
key:
type: string
description: The `Unpadded Base64`_ encoded key.
description: The [Unpadded base64](/appendices/#unpadded-base64) encoded key.
example: "VGhpcyBzaG91bGQgYmUgeW91ciBvbGQga2V5J3MgZWQyNTUxOSBwYXlsb2FkLg"
required: ["expired_ts", "key"]
signatures:
@ -78,8 +78,7 @@ properties:
description: |-
Digital signatures for this object signed using the `verify_keys`.
The signature is calculated using the process described at `Signing
JSON`_.
The signature is calculated using the process described at [Signing JSON](/appendices/#signing-json).
title: Signatures
additionalProperties:
type: object
@ -91,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`_.
be considered invalid, depending on the [room version specification](/#room-versions).
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

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

@ -24,7 +24,7 @@ allOf:
type: object
title: Event Hash
description: |-
Content hashes of the PDU, following the algorithm specified in `Signing Events`_.
Content hashes of the PDU, following the algorithm specified in [Signing Events](/server-server-api/#signing-events).
example: {
"sha256": "ThisHashCoversAllFieldsInCaseThisIsRedacted"
}
@ -37,7 +37,7 @@ allOf:
signatures:
type: object
description: |-
Signatures for the PDU, following the algorithm specified in `Signing Events`_.
Signatures for the PDU, following the algorithm specified in [Signing Events](/server-server-api/#signing-events).
example: {
"example.com": {
"ed25519:key_version:": "86BytesOfSignatureOfTheRedactedEvent"

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

@ -52,7 +52,7 @@ allOf:
type: object
title: Event Hash
description: |-
Content hashes of the PDU, following the algorithm specified in `Signing Events`_.
Content hashes of the PDU, following the algorithm specified in [Signing Events](/server-server-api/#signing-events).
example: {
"sha256": "ThisHashCoversAllFieldsInCaseThisIsRedacted"
}
@ -65,7 +65,7 @@ allOf:
signatures:
type: object
description: |-
Signatures for the PDU, following the algorithm specified in `Signing Events`_.
Signatures for the PDU, following the algorithm specified in [Signing Events](/server-server-api/#signing-events).
example: {
"example.com": {
"ed25519:key_version:": "86BytesOfSignatureOfTheRedactedEvent"

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

@ -14,6 +14,6 @@
signedRequest:
type: apiKey
description: |-
The `Authorization` header defined in the `Authentication`_ section.
The `Authorization` header defined in the [Authentication](/server-server-api/#authentication) section.
name: Authorization
in: header

12
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`_ for precise event formats.
[room version specification](/#room-versions) for precise event formats.
items:
type: object
title: PDU
description: |-
The `PDUs <#pdus>`_ that make up the auth chain. The event format varies depending
on the room version - check the `room version specification`_ for precise event formats.
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.
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`_
The event format varies depending on the room version - check the [room version specification](/#room-versions)
for precise event formats.
items:
type: object
title: PDU
description: |-
The `PDUs <#pdus>`_ for the fully resolved state of the room. The event format varies depending
on the room version - check the `room version specification`_ for precise event formats.
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.
schema:
type: object
properties: []

6
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`_ for precise event formats.
version - check the [room version specification](/#room-versions) for precise event formats.
items:
type: object
title: PDU
description: |-
The `PDUs <#pdus>`_ contained in the transaction. The event format varies depending
on the room version - check the `room version specification`_ for precise event formats.
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.
properties: []
example:
$ref: "../examples/minimal_pdu.json"

6
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`_ for precise event formats.
[room version specification](/#room-versions) for precise event formats.
items:
type: object
title: PDU
description: |-
The `PDUs <#pdus>`_ contained in the transaction. The event format varies depending
on the room version - check the `room version specification`_ for precise event formats.
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.
properties: []
example:
$ref: "../examples/minimal_pdu.json"

6
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`_ for
depending on the room version - check the [room version specification](/#room-versions) for
precise event formats.
items:
type: object
title: PDU
description: |-
The `PDUs <#pdus>`_ contained in the transaction. The event format varies depending
on the room version - check the `room version specification`_ for precise event formats.
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.
properties: []
example:
$ref: "../examples/minimal_pdu.json"

6
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`_ for precise event formats.
check the [room version specification](/#room-versions) 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`_
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)
for precise event formats.
properties: []
example:

12
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`_ for precise event formats.
check the [room version specification](/#room-versions) 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`_
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)
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`_ for precise event formats.
check the [room version specification](/#room-versions) for precise event formats.
items:
type: object
title: PDU
description: |-
The `PDUs <#pdus>`_ for the fully resolved state of the room. The event format
varies depending on the room version - check the `room version specification`_
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.
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`_ for precise event formats. **The request and response
[room version specification](/#room-versions) 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`_ for precise event formats.
room version - check the [room version specification](/#room-versions) 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`_ for precise event formats. **The request and response
[room version specification](/#room-versions) 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`_ for precise event formats.
room version - check the [room version specification](/#room-versions) for precise event formats.
schema:
type: object
description: An object containing the signed invite event.

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

@ -62,9 +62,9 @@ paths:
responses:
200:
description: |-
A template to be used for the rest of the `Joining Rooms`_ handshake. Note that
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`_ for precise event formats. **The response body
[room version specification](/#room-versions) 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`_
depending on the room version - check the [room version specification](/#room-versions)
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`_ for precise event formats.
the [room version specification](/#room-versions) 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`_ for precise event formats.
the [room version specification](/#room-versions) 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`_ for precise event formats. **The response body
[room version specification](/#room-versions) 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`_
depending on the room version - check the [room version specification](/#room-versions)
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`_ for precise event formats.
the [room version specification](/#room-versions) 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`_ for precise event formats.
the [room version specification](/#room-versions) 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.**

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

@ -33,7 +33,7 @@ paths:
description: |-
The receiving server will verify the partial `m.room.member` event
given in the request body. If valid, the receiving server will issue
an invite as per the `Inviting to a room`_ section before returning a
an invite as per the [Inviting to a room](/server-server-api/#inviting-to-a-room) section before returning a
response to this request.
operationId: exchangeThirdPartyInvite
security:
@ -111,7 +111,7 @@ paths:
The server signatures for this event.
The signature is calculated using the process
described at `Signing JSON`_.
described at [Signing JSON](/appendices/#signing-json).
example: {
"magic.forest": {
"ed25519:3": "fQpGIW1Snz+pwLZu6sTy2aHy/DYWWTspTJRPyNp0PKkymfIsNffysMl6ObMMFdIJhk6g6pwlIqZ54rxo8SLmAg"

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`_ for precise event formats.
the [room version specification](/#room-versions) for precise event formats.
operationId: sendTransaction
security:
- signedRequest: []

5
data/api/server-server/user_keys.yaml
View file

@ -74,7 +74,7 @@ paths:
One-time keys for the queried devices. A map from user ID, to a
map from devices to a map from `<algorithm>:<key_id>` to the key object.
See the `Client-Server Key Algorithms`_ section for more information on
See the [Client-Server Key Algorithms](/client-server-api/#key-algorithms) section for more information on
the Key Object format.
additionalProperties:
type: object
@ -97,8 +97,7 @@ paths:
description: |-
Signature of the key object.
The signature is calculated using the process described at `Signing
JSON`_.
The signature is calculated using the process described at [Signing JSON](/appendices/#signing-json).
required: ['key', 'signatures']
example: {
"@alice:example.com": {

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

@ -50,4 +50,4 @@ paths:
description: |-
The server name to delegate server-server communciations to, with optional
port. The delegated server name uses the same grammar as
`server names in the appendices <../appendices.html#server-name>`_.
[server names in the appendices](/appendices/#server-name).