mark which fields are required

pull/977/head
Hubert Chathi 6 years ago
parent ec2e02e8b5
commit c02ecb58ae

@ -57,13 +57,15 @@ Requests a key verification.
Properties: Properties:
- `from_device` (string): the device ID of the device requesting verification. - `from_device` (string): Required. The device ID of the device requesting
- `transaction_id` (string): an identifier for the verification request. Must verification.
be unique with respect to the pair of devices. - `transaction_id` (string): Required. An identifier for the verification
- `methods` ([string]): the verification methods supported by the sender. request. Must be unique with respect to the pair of devices.
- `timestamp` (integer): the time when the request was made. If the timestamp - `methods` ([string]): Required. The verification methods supported by the
is in the future (by more than 5 minutes, to allow for clock skew), or more sender.
than 10 minutes in the past, then the message must be ignored. - `timestamp` (integer): Required. The time when the request was made. If the
timestamp is in the future (by more than 5 minutes, to allow for clock skew),
or more than 10 minutes in the past, then the message must be ignored.
#### `m.key.verification.start` #### `m.key.verification.start`
@ -71,13 +73,13 @@ Begins a key verification process.
Properties: Properties:
- `method` (string): the verification method to use. - `method` (string): Required. The verification method to use.
- `from_device` (string): The device ID of the device starting the verification - `from_device` (string): Required. The device ID of the device starting the
process. verification process.
- `transaction_id` (string): an identifier for the verification process. If - `transaction_id` (string): Required. An identifier for the verification
this message is sent in reponse to an `m.key.verification.request` event, then process. If this message is sent in reponse to an
it must use the same `transaction_id` as the one given in the `m.key.verification.request` event, then it must use the same
`m.key.verification.request`. `transaction_id` as the one given in the `m.key.verification.request`.
Key verification methods can define additional properties to be included. Key verification methods can define additional properties to be included.

Loading…
Cancel
Save