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
127 lines
4 KiB
YAML
127 lines
4 KiB
YAML
# Copyright 2016 OpenMarket Ltd
|
|
# 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.
|
|
swagger: '2.0'
|
|
info:
|
|
title: "Matrix Identity Service Public Key API"
|
|
version: "2.0.0"
|
|
host: localhost:8090
|
|
schemes:
|
|
- https
|
|
basePath: /_matrix/identity/v2
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
paths:
|
|
"/pubkey/{keyId}":
|
|
get:
|
|
summary: Get a public key.
|
|
description: |-
|
|
Get the public key for the passed key ID.
|
|
operationId: getPubKeyV2
|
|
parameters:
|
|
- in: path
|
|
type: string
|
|
name: keyId
|
|
required: true
|
|
description: |-
|
|
The ID of the key. This should take the form algorithm:identifier
|
|
where algorithm identifies the signing algorithm, and the identifier
|
|
is an opaque string.
|
|
x-example: "ed25519:0"
|
|
responses:
|
|
200:
|
|
description:
|
|
The public key exists.
|
|
examples:
|
|
application/json: {
|
|
"public_key": "VXuGitF39UH5iRfvbIknlvlAVKgD1BsLDMvBf0pmp7c"
|
|
}
|
|
schema:
|
|
type: object
|
|
properties:
|
|
public_key:
|
|
type: string
|
|
description: Unpadded Base64 encoded public key.
|
|
required: ['public_key']
|
|
404:
|
|
description:
|
|
The public key was not found.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "M_NOT_FOUND",
|
|
"error": "The public key was not found"
|
|
}
|
|
schema:
|
|
$ref: "../client-server/definitions/errors/error.yaml"
|
|
"/pubkey/isvalid":
|
|
get:
|
|
summary: Check whether a long-term public key is valid.
|
|
description: |-
|
|
Check whether a long-term public key is valid. The response should always
|
|
be the same, provided the key exists.
|
|
operationId: isPubKeyValidV2
|
|
parameters:
|
|
- in: query
|
|
type: string
|
|
name: public_key
|
|
required: true
|
|
description: |-
|
|
The unpadded base64-encoded public key to check.
|
|
x-example: "VXuGitF39UH5iRfvbIknlvlAVKgD1BsLDMvBf0pmp7c"
|
|
responses:
|
|
200:
|
|
description:
|
|
The validity of the public key.
|
|
examples:
|
|
application/json: {
|
|
"valid": true
|
|
}
|
|
schema:
|
|
type: object
|
|
properties:
|
|
valid:
|
|
type: boolean
|
|
description: Whether the public key is recognised and is currently valid.
|
|
required: ['valid']
|
|
"/pubkey/ephemeral/isvalid":
|
|
get:
|
|
summary: Check whether a short-term public key is valid.
|
|
description: |-
|
|
Check whether a short-term public key is valid.
|
|
operationId: isEphemeralPubKeyValidV2
|
|
parameters:
|
|
- in: query
|
|
type: string
|
|
name: public_key
|
|
required: true
|
|
description: |-
|
|
The unpadded base64-encoded public key to check.
|
|
x-example: "VXuGitF39UH5iRfvbIknlvlAVKgD1BsLDMvBf0pmp7c"
|
|
responses:
|
|
200:
|
|
description:
|
|
The validity of the public key.
|
|
examples:
|
|
application/json: {
|
|
"valid": true
|
|
}
|
|
schema:
|
|
type: object
|
|
properties:
|
|
valid:
|
|
type: boolean
|
|
description: Whether the public key is recognised and is currently valid.
|
|
required: ['valid']
|