00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
50 lines
1.6 KiB
YAML
50 lines
1.6 KiB
YAML
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
type: object
|
|
title: KeyBackupData
|
|
description: "The key data"
|
|
properties:
|
|
first_message_index:
|
|
description: |-
|
|
The index of the first message in the session that the key can decrypt.
|
|
type: integer
|
|
example: 1
|
|
forwarded_count:
|
|
description: |-
|
|
The number of times this key has been forwarded via key-sharing between devices.
|
|
type: integer
|
|
example: 0
|
|
is_verified:
|
|
description: |-
|
|
Whether the device backing up the key verified the device that the key
|
|
is from.
|
|
type: boolean
|
|
example: false
|
|
session_data:
|
|
description: |-
|
|
Algorithm-dependent data. See the documentation for the backup
|
|
algorithms in `Server-side key backups`_ for more information on the
|
|
expected format of the data.
|
|
type: object
|
|
example: {
|
|
"ephemeral": "base64+ephemeral+key",
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
"mac": "base64+mac+of+ciphertext"
|
|
}
|
|
required:
|
|
- first_message_index
|
|
- forwarded_count
|
|
- is_verified
|
|
- session_data
|