|
|
@ -54,13 +54,13 @@ paths:
|
|
|
|
expected format of the data.
|
|
|
|
expected format of the data.
|
|
|
|
type: object
|
|
|
|
type: object
|
|
|
|
example: {
|
|
|
|
example: {
|
|
|
|
"public_key": "abcdefg",
|
|
|
|
"public_key": "abcdefg",
|
|
|
|
"signatures": {
|
|
|
|
"signatures": {
|
|
|
|
"@alice:example.org": {
|
|
|
|
"@alice:example.org": {
|
|
|
|
"ed25519:deviceid": "signature"
|
|
|
|
"ed25519:deviceid": "signature"
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
required:
|
|
|
|
required:
|
|
|
|
- algorithm
|
|
|
|
- algorithm
|
|
|
|
- auth_data
|
|
|
|
- auth_data
|
|
|
@ -115,13 +115,13 @@ paths:
|
|
|
|
expected format of the data.
|
|
|
|
expected format of the data.
|
|
|
|
type: object
|
|
|
|
type: object
|
|
|
|
example: {
|
|
|
|
example: {
|
|
|
|
"public_key": "abcdefg",
|
|
|
|
"public_key": "abcdefg",
|
|
|
|
"signatures": {
|
|
|
|
"signatures": {
|
|
|
|
"@alice:example.org": {
|
|
|
|
"@alice:example.org": {
|
|
|
|
"ed25519:deviceid": "signature"
|
|
|
|
"ed25519:deviceid": "signature"
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
count:
|
|
|
|
count:
|
|
|
|
description: The number of keys stored in the backup.
|
|
|
|
description: The number of keys stored in the backup.
|
|
|
|
type: integer
|
|
|
|
type: integer
|
|
|
@ -191,13 +191,13 @@ paths:
|
|
|
|
expected format of the data.
|
|
|
|
expected format of the data.
|
|
|
|
type: object
|
|
|
|
type: object
|
|
|
|
example: {
|
|
|
|
example: {
|
|
|
|
"public_key": "abcdefg",
|
|
|
|
"public_key": "abcdefg",
|
|
|
|
"signatures": {
|
|
|
|
"signatures": {
|
|
|
|
"@alice:example.org": {
|
|
|
|
"@alice:example.org": {
|
|
|
|
"ed25519:deviceid": "signature"
|
|
|
|
"ed25519:deviceid": "signature"
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
version:
|
|
|
|
version:
|
|
|
|
description: |-
|
|
|
|
description: |-
|
|
|
|
The backup version. If present, must be the same as the
|
|
|
|
The backup version. If present, must be the same as the
|
|
|
@ -283,10 +283,10 @@ paths:
|
|
|
|
field.
|
|
|
|
field.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_WRONG_ROOM_KEYS_VERSION",
|
|
|
|
"errcode": "M_WRONG_ROOM_KEYS_VERSION",
|
|
|
|
"error": "Wrong backup version.",
|
|
|
|
"error": "Wrong backup version.",
|
|
|
|
"current_version": "42"
|
|
|
|
"current_version": "42"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
tags:
|
|
|
|
tags:
|
|
|
@ -327,9 +327,9 @@ paths:
|
|
|
|
description: The key or backup was not found.
|
|
|
|
description: The key or backup was not found.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"error": "Key not found."
|
|
|
|
"error": "Key not found."
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
delete:
|
|
|
|
delete:
|
|
|
@ -383,9 +383,9 @@ paths:
|
|
|
|
The backup was not found.
|
|
|
|
The backup was not found.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"/room_keys/keys/{roomId}":
|
|
|
|
"/room_keys/keys/{roomId}":
|
|
|
@ -424,12 +424,12 @@ paths:
|
|
|
|
allOf:
|
|
|
|
allOf:
|
|
|
|
- $ref: "definitions/key_backup_data.yaml"
|
|
|
|
- $ref: "definitions/key_backup_data.yaml"
|
|
|
|
example: {
|
|
|
|
example: {
|
|
|
|
"sessionid1": {
|
|
|
|
"sessionid1": {
|
|
|
|
"ephemeral": "base64+ephemeral+key",
|
|
|
|
"ephemeral": "base64+ephemeral+key",
|
|
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
|
|
"mac": "base64+mac+of+ciphertext"
|
|
|
|
"mac": "base64+mac+of+ciphertext"
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
responses:
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
200:
|
|
|
|
description: The update succeeded
|
|
|
|
description: The update succeeded
|
|
|
@ -467,9 +467,9 @@ paths:
|
|
|
|
The backup was not found.
|
|
|
|
The backup was not found.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
tags:
|
|
|
|
tags:
|
|
|
@ -511,20 +511,20 @@ paths:
|
|
|
|
allOf:
|
|
|
|
allOf:
|
|
|
|
- $ref: "definitions/key_backup_data.yaml"
|
|
|
|
- $ref: "definitions/key_backup_data.yaml"
|
|
|
|
example: {
|
|
|
|
example: {
|
|
|
|
"sessionid1": {
|
|
|
|
"sessionid1": {
|
|
|
|
"ephemeral": "base64+ephemeral+key",
|
|
|
|
"ephemeral": "base64+ephemeral+key",
|
|
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
|
|
"mac": "base64+mac+of+ciphertext"
|
|
|
|
"mac": "base64+mac+of+ciphertext"
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
404:
|
|
|
|
404:
|
|
|
|
description: |-
|
|
|
|
description: |-
|
|
|
|
The backup was not found.
|
|
|
|
The backup was not found.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
delete:
|
|
|
|
delete:
|
|
|
@ -572,9 +572,9 @@ paths:
|
|
|
|
The backup was not found.
|
|
|
|
The backup was not found.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"/room_keys/keys":
|
|
|
|
"/room_keys/keys":
|
|
|
@ -609,16 +609,16 @@ paths:
|
|
|
|
allOf:
|
|
|
|
allOf:
|
|
|
|
- $ref: "definitions/key_backup_data.yaml"
|
|
|
|
- $ref: "definitions/key_backup_data.yaml"
|
|
|
|
example: {
|
|
|
|
example: {
|
|
|
|
"!room:example.org": {
|
|
|
|
"!room:example.org": {
|
|
|
|
"sessions": {
|
|
|
|
"sessions": {
|
|
|
|
"sessionid1": {
|
|
|
|
"sessionid1": {
|
|
|
|
"ephemeral": "base64+ephemeral+key",
|
|
|
|
"ephemeral": "base64+ephemeral+key",
|
|
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
|
|
"mac": "base64+mac+of+ciphertext"
|
|
|
|
"mac": "base64+mac+of+ciphertext"
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
responses:
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
200:
|
|
|
|
description: The update succeeded
|
|
|
|
description: The update succeeded
|
|
|
@ -645,10 +645,10 @@ paths:
|
|
|
|
field.
|
|
|
|
field.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_WRONG_ROOM_KEYS_VERSION",
|
|
|
|
"errcode": "M_WRONG_ROOM_KEYS_VERSION",
|
|
|
|
"error": "Wrong backup version.",
|
|
|
|
"error": "Wrong backup version.",
|
|
|
|
"current_version": "42"
|
|
|
|
"current_version": "42"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
404:
|
|
|
|
404:
|
|
|
@ -656,9 +656,9 @@ paths:
|
|
|
|
The backup was not found.
|
|
|
|
The backup was not found.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
tags:
|
|
|
|
tags:
|
|
|
@ -696,23 +696,23 @@ paths:
|
|
|
|
allOf:
|
|
|
|
allOf:
|
|
|
|
- $ref: "definitions/key_backup_data.yaml"
|
|
|
|
- $ref: "definitions/key_backup_data.yaml"
|
|
|
|
example: {
|
|
|
|
example: {
|
|
|
|
"!room:example.org": {
|
|
|
|
"!room:example.org": {
|
|
|
|
"sessions": {
|
|
|
|
"sessions": {
|
|
|
|
"sessionid1": {
|
|
|
|
"sessionid1": {
|
|
|
|
"ephemeral": "base64+ephemeral+key",
|
|
|
|
"ephemeral": "base64+ephemeral+key",
|
|
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
|
|
"ciphertext": "base64+ciphertext+of+JSON+data",
|
|
|
|
"mac": "base64+mac+of+ciphertext"
|
|
|
|
"mac": "base64+mac+of+ciphertext"
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
404:
|
|
|
|
404:
|
|
|
|
description: The backup was not found.
|
|
|
|
description: The backup was not found.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"error": "Unknown backup version."
|
|
|
|
"error": "Unknown backup version."
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
delete:
|
|
|
|
delete:
|
|
|
@ -754,8 +754,8 @@ paths:
|
|
|
|
The backup was not found.
|
|
|
|
The backup was not found.
|
|
|
|
examples:
|
|
|
|
examples:
|
|
|
|
application/json: {
|
|
|
|
application/json: {
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"errcode": "M_NOT_FOUND",
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
"error": "Unknown backup version"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
schema:
|
|
|
|
schema:
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|
"$ref": "definitions/errors/error.yaml"
|
|
|
|