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
279 lines
9.7 KiB
YAML
279 lines
9.7 KiB
YAML
# 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 Application Service API"
|
|
version: "1.0.0"
|
|
host: localhost:8008
|
|
schemes:
|
|
- https
|
|
- http
|
|
basePath: /_matrix/app/v1
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
securityDefinitions:
|
|
$ref: definitions/security.yaml
|
|
paths:
|
|
"/thirdparty/protocol/{protocol}":
|
|
get:
|
|
summary: Retrieve metadata about a specific protocol that the application service supports.
|
|
description: |-
|
|
This API is called by the homeserver when it wants to present clients
|
|
with specific information about the various third party networks that
|
|
an application service supports.
|
|
operationId: getProtocolMetadata
|
|
security:
|
|
- homeserverAccessToken: []
|
|
parameters:
|
|
- in: path
|
|
name: protocol
|
|
type: string
|
|
description: The protocol ID.
|
|
required: true
|
|
x-example: "irc"
|
|
responses:
|
|
200:
|
|
description: The protocol was found and metadata returned.
|
|
schema:
|
|
$ref: definitions/protocol_metadata.yaml
|
|
401:
|
|
description: |-
|
|
The homeserver has not supplied credentials to the application service.
|
|
Optional error information can be included in the body of this response.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_UNAUTHORIZED"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
403:
|
|
description: |-
|
|
The credentials supplied by the homeserver were rejected.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_FORBIDDEN"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
404:
|
|
description: No protocol was found with the given path.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_NOT_FOUND"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
"/thirdparty/user/{protocol}":
|
|
get:
|
|
summary: Retrieve the Matrix User ID of a corresponding third party user.
|
|
description: |-
|
|
This API is called by the homeserver in order to retrieve a Matrix
|
|
User ID linked to a user on the third party network, given a set of
|
|
user parameters.
|
|
operationId: queryUserByProtocol
|
|
security:
|
|
- homeserverAccessToken: []
|
|
parameters:
|
|
- in: path
|
|
name: protocol
|
|
type: string
|
|
description: The protocol ID.
|
|
required: true
|
|
x-example: irc
|
|
- in: query
|
|
name: fields...
|
|
type: string
|
|
description: |-
|
|
One or more custom fields that are passed to the application
|
|
service to help identify the user.
|
|
responses:
|
|
200:
|
|
description: The Matrix User IDs found with the given parameters.
|
|
schema:
|
|
$ref: definitions/user_batch.yaml
|
|
401:
|
|
description: |-
|
|
The homeserver has not supplied credentials to the application service.
|
|
Optional error information can be included in the body of this response.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_UNAUTHORIZED"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
403:
|
|
description: |-
|
|
The credentials supplied by the homeserver were rejected.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_FORBIDDEN"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
404:
|
|
description: No users were found with the given parameters.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_NOT_FOUND"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
"/thirdparty/location/{protocol}":
|
|
get:
|
|
summary: Retrieve Matrix-side portal rooms leading to a third party location.
|
|
description: |-
|
|
Retrieve a list of Matrix portal rooms that lead to the matched third party location.
|
|
operationId: queryLocationByProtocol
|
|
security:
|
|
- homeserverAccessToken: []
|
|
parameters:
|
|
- in: path
|
|
name: protocol
|
|
type: string
|
|
description: The protocol ID.
|
|
required: true
|
|
x-example: irc
|
|
- in: query
|
|
name: fields...
|
|
type: string
|
|
description: |-
|
|
One or more custom fields that are passed to the application
|
|
service to help identify the third party location.
|
|
responses:
|
|
200:
|
|
description: At least one portal room was found.
|
|
schema:
|
|
$ref: definitions/location_batch.yaml
|
|
401:
|
|
description: |-
|
|
The homeserver has not supplied credentials to the application service.
|
|
Optional error information can be included in the body of this response.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_UNAUTHORIZED"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
403:
|
|
description: |-
|
|
The credentials supplied by the homeserver were rejected.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_FORBIDDEN"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
404:
|
|
description: No mappings were found with the given parameters.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_NOT_FOUND"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
"/thirdparty/location":
|
|
get:
|
|
summary: Reverse-lookup third party locations given a Matrix room alias.
|
|
description: |-
|
|
Retrieve an array of third party network locations from a Matrix room
|
|
alias.
|
|
operationId: queryLocationByAlias
|
|
security:
|
|
- homeserverAccessToken: []
|
|
parameters:
|
|
- in: query
|
|
name: alias
|
|
type: string
|
|
description: The Matrix room alias to look up.
|
|
responses:
|
|
200:
|
|
description: |-
|
|
All found third party locations.
|
|
schema:
|
|
$ref: definitions/location_batch.yaml
|
|
401:
|
|
description: |-
|
|
The homeserver has not supplied credentials to the application service.
|
|
Optional error information can be included in the body of this response.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_UNAUTHORIZED"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
403:
|
|
description: |-
|
|
The credentials supplied by the homeserver were rejected.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_FORBIDDEN"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
404:
|
|
description: No mappings were found with the given parameters.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_NOT_FOUND"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
"/thirdparty/user":
|
|
get:
|
|
summary: Reverse-lookup third party users given a Matrix User ID.
|
|
description: |-
|
|
Retrieve an array of third party users from a Matrix User ID.
|
|
operationId: queryUserByID
|
|
security:
|
|
- homeserverAccessToken: []
|
|
parameters:
|
|
- in: query
|
|
name: userid
|
|
type: string
|
|
description: The Matrix User ID to look up.
|
|
responses:
|
|
200:
|
|
description: |-
|
|
An array of third party users.
|
|
schema:
|
|
$ref: definitions/user_batch.yaml
|
|
401:
|
|
description: |-
|
|
The homeserver has not supplied credentials to the application service.
|
|
Optional error information can be included in the body of this response.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_UNAUTHORIZED"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
403:
|
|
description: |-
|
|
The credentials supplied by the homeserver were rejected.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_UNAUTHORIZED"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
404:
|
|
description: No mappings were found with the given parameters.
|
|
examples:
|
|
application/json: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_NOT_FOUND"
|
|
}
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|