Split out and fix the /server and /query key APIs

This commit is contained in:
Travis Ralston 2018-07-11 13:20:44 -06:00
parent bd2c0b7c98
commit 96889f16e9
3 changed files with 53 additions and 74 deletions

View file

@ -23,23 +23,6 @@ basePath: /_matrix/key/v2
produces:
- application/json
paths:
"/server/{keyId}":
get:
summary: Get the server's key
description: Get the server's key
operationId: getServerKey
parameters:
- in: path
name: keyId
type: string
description: Key ID
required: false
x-example: TODO # No examples in the spec so far
responses:
200:
description: The server's keys
schema:
$ref: "definitions/keys.yaml"
"/query/{serverName}/{keyId}":
get:
summary: Retreive a server key
@ -100,20 +83,16 @@ paths:
name: ServerName
description: The server names to query
additionalProperties:
type: array
name: ServerKey
type: object
title: Query Criteria
description: The server keys to query
items:
type: object
title: Query Criteria
description: The query criteria
properties:
minimum_valid_until_ts:
type: integer
format: int64
description: Minimum Valid Until MS
required: true # TODO: Verify
x-example: 1234567890
properties:
minimum_valid_until_ts:
type: integer
format: int64
description: Minimum Valid Until MS
required: true # TODO: Verify
example: 1234567890
responses:
200:
description: The keys for the server

View file

@ -0,0 +1,42 @@
# Copyright 2018 New Vector 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.
swagger: '2.0'
info:
title: "Matrix Federation Key Exchange API"
version: "1.0.0"
host: localhost:8448
schemes:
- https
basePath: /_matrix/key/v2
produces:
- application/json
paths:
"/server/{keyId}":
get:
summary: Get the server's key
description: Get the server's key
operationId: getServerKey
parameters:
- in: path
name: keyId
type: string
description: Key ID
required: false
x-example: TODO # No examples in the spec so far
responses:
200:
description: The server's keys
schema:
$ref: "definitions/keys.yaml"