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
69 lines
2.2 KiB
YAML
69 lines
2.2 KiB
YAML
# Copyright 2016 OpenMarket Ltd
|
|
#
|
|
# 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: DeviceKeys
|
|
description: Device identity keys
|
|
properties:
|
|
user_id:
|
|
type: string
|
|
description: |-
|
|
The ID of the user the device belongs to. Must match the user ID used
|
|
when logging in.
|
|
example: "@alice:example.com"
|
|
device_id:
|
|
type: string
|
|
description: |-
|
|
The ID of the device these keys belong to. Must match the device ID used
|
|
when logging in.
|
|
example: "JLAFKJWSCS"
|
|
algorithms:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: |-
|
|
The encryption algorithms supported by this device.
|
|
example: ["m.olm.v1.curve25519-aes-sha2", "m.megolm.v1.aes-sha2"]
|
|
keys:
|
|
type: object
|
|
description: |-
|
|
Public identity keys. The names of the properties should be in the
|
|
format ``<algorithm>:<device_id>``. The keys themselves should be
|
|
encoded as specified by the key algorithm.
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
"curve25519:JLAFKJWSCS": "3C5BFWi2Y8MaVvjM8M22DBmh24PmgR0nPvJOIArzgyI"
|
|
"ed25519:JLAFKJWSCS": "lEuiRJBit0IG6nUf5pUzWTUEsRVVe/HJkoKuEww9ULI"
|
|
signatures:
|
|
type: object
|
|
title: Signatures
|
|
description: |-
|
|
Signatures for the device key object. A map from user ID, to a map from
|
|
``<algorithm>:<device_id>`` to the signature.
|
|
|
|
The signature is calculated using the process described at `Signing
|
|
JSON`_.
|
|
additionalProperties:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
"@alice:example.com":
|
|
"ed25519:JLAFKJWSCS": "dSO80A01XiigH3uBiDVx/EjzaoycHcjq9lfQX0uWsqxl2giMIiSPR8a4d291W1ihKJL/a+myXS367WT6NAIcBA"
|
|
required:
|
|
- user_id
|
|
- device_id
|
|
- algorithms
|
|
- keys
|
|
- signatures
|