Corrections to the response format of /_matrix/identity/v2/store-invite
(#1486)
This has been wrong since the dawn of time. Fixes https://github.com/matrix-org/matrix-spec/issues/495
This commit is contained in:
parent
cafb453545
commit
6150f71ba1
2 changed files with 31 additions and 11 deletions
|
@ -142,20 +142,39 @@ paths:
|
|||
A list of [server's long-term public key, generated ephemeral
|
||||
public key].
|
||||
items:
|
||||
type: string
|
||||
type: object
|
||||
title: PublicKey
|
||||
properties:
|
||||
public_key:
|
||||
type: string
|
||||
description: |
|
||||
The public key, encoded using [unpadded Base64](/appendices/#unpadded-base64).
|
||||
key_validity_url:
|
||||
type: string
|
||||
description: |
|
||||
The URI of an endpoint where the validity of this key can be checked
|
||||
by passing it as a `public_key` query parameter. See
|
||||
[key management](/identity-service-api/#key-management).
|
||||
required: ['public_key', 'key_validity_url']
|
||||
display_name:
|
||||
type: string
|
||||
description: The generated (redacted) display_name.
|
||||
description: The generated (redacted) display name.
|
||||
required: ['token', 'public_keys', 'display_name']
|
||||
example:
|
||||
application/json: {
|
||||
"token": "sometoken",
|
||||
"public_keys": [
|
||||
"serverpublickey",
|
||||
"ephemeralpublickey"
|
||||
],
|
||||
"display_name": "f...@b..."
|
||||
}
|
||||
examples:
|
||||
application/json: {
|
||||
"token": "sometoken",
|
||||
"public_keys": [
|
||||
{
|
||||
"public_key": "serverPublicKeyBase64",
|
||||
"key_validity_url": "https://example.com/_matrix/identity/v2/pubkey/isvalid"
|
||||
},
|
||||
{
|
||||
"public_key": "ephemeralPublicKeyBase64",
|
||||
"key_validity_url": "https://example.com/_matrix/identity/v2/pubkey/ephemeral/isvalid"
|
||||
}
|
||||
],
|
||||
"display_name": "f...@b..."
|
||||
}
|
||||
400:
|
||||
description: |
|
||||
An error has occurred.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue