Convert the general query API to swagger
Includes "moving" the directory query API into the same area. This will make more sense once the other query types are specified.pull/1412/head
parent
91c59e7384
commit
51faf8ed2e
@ -0,0 +1,44 @@
|
|||||||
|
# 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 Query API"
|
||||||
|
version: "1.0.0"
|
||||||
|
host: localhost:8448
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
basePath: /_matrix/federation/v1
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
paths:
|
||||||
|
"/query/{queryType}":
|
||||||
|
get:
|
||||||
|
summary: Query for information
|
||||||
|
description: |-
|
||||||
|
Performs a single query request on the receiving homeserver. The query string
|
||||||
|
arguments are dependent on which type of query is being made. Known query types
|
||||||
|
are specified as their own endpoints as an extension to this definition.
|
||||||
|
operationId: queryInfo
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: queryType
|
||||||
|
type: string
|
||||||
|
description: The type of query to make
|
||||||
|
required: true
|
||||||
|
x-example: profile
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: |-
|
||||||
|
The query response. The schema varies depending on the query being made.
|
Loading…
Reference in New Issue