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

Change RST code formatting markup to Markdown

Browse source
This commit is contained in:
Will 2021-01-27 12:14:31 -08:00 • committed by Richard van der Hoff
parent c7cf90abfa
commit 27f8867aa0
158 changed files with 931 additions and 931 deletions
Download patch file Download diff file Expand all files Collapse all files

6
data/api/server-server/definitions/event-schemas/m.device_list_update.yaml
View file

@ -32,7 +32,7 @@ allOf:
edu_type:
type: enum
enum: ['m.device_list_update']
description: The string ``m.device_list_update``.
description: The string `m.device_list_update`.
example: "m.device_list_update"
content:
type: object
@ -57,7 +57,7 @@ allOf:
type: integer
description: |-
An ID sent by the server for this update, unique for a given
user_id. Used to identify any gaps in the sequence of ``m.device_list_update``
user_id. Used to identify any gaps in the sequence of `m.device_list_update`
EDUs broadcast by a server.
example: 6
prev_id:
@ -67,7 +67,7 @@ allOf:
which have not been referred to already in an EDU's prev_id field. If the
receiving server does not recognise any of the prev_ids, it means an EDU
has been lost and the server should query a snapshot of the device list
via ``/user/keys/query`` in order to correctly interpret future ``m.device_list_update``
via `/user/keys/query` in order to correctly interpret future `m.device_list_update`
EDUs. May be missing or empty for the first EDU in a sequence.
items:
type: integer

4
data/api/server-server/definitions/event-schemas/m.direct_to_device.yaml
View file

@ -25,7 +25,7 @@ allOf:
edu_type:
type: enum
enum: ['m.direct_to_device']
description: The string ``m.direct_to_device``.
description: The string `m.direct_to_device`.
example: "m.direct_to_device"
content:
type: object
@ -50,7 +50,7 @@ allOf:
description: |-
The contents of the messages to be sent. These are arranged in
a map of user IDs to a map of device IDs to message bodies.
The device ID may also be ``*``, meaning all known devices for the user.
The device ID may also be `*`, meaning all known devices for the user.
additionalProperties:
type: object
title: User Devices

6
data/api/server-server/definitions/event-schemas/m.presence.yaml
View file

@ -23,7 +23,7 @@ allOf:
edu_type:
type: enum
enum: ['m.presence']
description: The string ``m.presence``
description: The string `m.presence`
example: "m.presence"
content:
type: object
@ -63,8 +63,8 @@ allOf:
type: boolean
description: |-
True if the user is likely to be interacting with their
client. This may be indicated by the user having a
``last_active_ago`` within the last few minutes. Defaults
client. This may be indicated by the user having a
`last_active_ago` within the last few minutes. Defaults
to false.
example: true
required: ['user_id', 'presence', 'last_active_ago']

2
data/api/server-server/definitions/event-schemas/m.receipt.yaml
View file

@ -26,7 +26,7 @@ allOf:
edu_type:
type: enum
enum: ['m.receipt']
description: The string ``m.receipt``
description: The string `m.receipt`
example: "m.receipt"
content:
type: object

2
data/api/server-server/definitions/event-schemas/m.signing_key_update.yaml
View file

@ -24,7 +24,7 @@ allOf:
edu_type:
type: enum
enum: ['m.signing_key_update']
description: The string ``m.signing_update``.
description: The string `m.signing_update`.
example: "m.signing_key_update"
content:
type: object

2
data/api/server-server/definitions/event-schemas/m.typing.yaml
View file

@ -22,7 +22,7 @@ allOf:
edu_type:
type: enum
enum: ['m.typing']
description: The string ``m.typing``
description: The string `m.typing`
example: "m.typing"
content:
type: object

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

@ -22,7 +22,7 @@ allOf:
sender:
type: string
description: |-
The matrix ID of the user who sent the original ``m.room.third_party_invite``.
The matrix ID of the user who sent the original `m.room.third_party_invite`.
example: "@someone:example.org"
origin:
type: string
@ -35,7 +35,7 @@ allOf:
example: 1234567890
type:
type: string
description: The value ``m.room.member``.
description: The value `m.room.member`.
example: "m.room.member"
state_key:
type: string
@ -46,12 +46,12 @@ 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`_. Must include a `membership` of `invite`.
example: {"membership": "invite"}
properties:
membership:
type: string
description: The value ``invite``.
description: The value `invite`.
example: "invite"
required: ['membership']
required:

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

@ -26,10 +26,10 @@ properties:
description: |-
Public keys of the homeserver for verifying digital signatures.
The object's key is the algorithm and version combined (``ed25519`` being the
algorithm and ``abc123`` being the version in the example below). Together,
The object's key is the algorithm and version combined (`ed25519` being the
algorithm and `abc123` being the version in the example below). Together,
this forms the Key ID. The version must have characters matching the regular
expression ``[a-zA-Z0-9_]``.
expression `[a-zA-Z0-9_]`.
additionalProperties:
type: object
title: Verify Key
@ -49,10 +49,10 @@ properties:
description: |-
The public keys that the server used to use and when it stopped using them.
The object's key is the algorithm and version combined (``ed25519`` being the
algorithm and ``0ldK3y`` being the version in the example below). Together,
The object's key is the algorithm and version combined (`ed25519` being the
algorithm and `0ldK3y` being the version in the example below). Together,
this forms the Key ID. The version must have characters matching the regular
expression ``[a-zA-Z0-9_]``.
expression `[a-zA-Z0-9_]`.
additionalProperties:
type: object
title: Old Verify Key
@ -76,7 +76,7 @@ properties:
signatures:
type: object
description: |-
Digital signatures for this object signed using the ``verify_keys``.
Digital signatures for this object signed using the `verify_keys`.
The signature is calculated using the process described at `Signing
JSON`_.

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`_ section.
name: Authorization
in: header

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

@ -20,7 +20,7 @@ properties:
origin:
type: string
description: |-
The ``server_name`` of the homeserver sending this transaction.
The `server_name` of the homeserver sending this transaction.
example: "example.org"
origin_server_ts:
type: integer

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

@ -27,7 +27,7 @@ properties:
example: "@someone:matrix.org"
origin:
type: string
description: The ``server_name`` of the homeserver that created this event.
description: The `server_name` of the homeserver that created this event.
example: "matrix.org"
origin_server_ts:
type: integer
@ -42,7 +42,7 @@ properties:
type: string
description: |-
If this key is present, the event is a state event, and it will replace previous events
with the same ``type`` and ``state_key`` in the room state.
with the same `type` and `state_key` in the room state.
example: "my_key"
content:
type: object
@ -77,7 +77,7 @@ properties:
depth:
type: integer
description: |-
The maximum depth of the ``prev_events``, plus one. Must be less than the
The maximum depth of the `prev_events`, plus one. Must be less than the
maximum value for an integer (2^63 - 1). If the room's depth is already at
the limit, the depth must be set to the limit.
example: 12
@ -117,7 +117,7 @@ properties:
type: object
title: UnsignedData
description: |-
Additional data added by the origin server but not covered by the ``signatures``. More
Additional data added by the origin server but not covered by the `signatures`. More
keys than those defined here may be used.
example: {"key": "value"}
properties: