Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Corrections to the response format of /_matrix/identity/v2/store-invite #1486

Merged
merged 2 commits into from
May 3, 2023
Merged

Corrections to the response format of /_matrix/identity/v2/store-invite #1486

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ad0db2
Corrections to the response format of `/_matrix/identity/v2/store-inv…
richvdh Apr 5, 2023
20d9941
Apply suggestions from code review
richvdh May 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/identity_service/newsfragments/1486.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Corrections to the response format of `/_matrix/identity/v2/store-invite`
richvdh marked this conversation as resolved.
Show resolved Hide resolved
39 changes: 29 additions & 10 deletions data/api/identity/v2_store_invite.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
richvdh marked this conversation as resolved.
Show resolved Hide resolved
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.
Expand Down