matrix-doc/api/client-server/wellknown.yaml

67 lines
2.5 KiB
YAML
Raw Permalink Normal View History

2018-07-03 18:14:26 +00:00
# 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 Client-Server Server Discovery API"
2018-07-03 18:14:26 +00:00
version: "1.0.0"
host: localhost:8008
schemes:
- https
basePath: /.well-known
produces:
- application/json
paths:
"/matrix/client":
get:
summary: Gets Matrix server discovery information about the domain.
description: |-
Gets discovery information about the domain. The file may include
2018-07-04 21:58:37 +00:00
additional keys, which MUST follow the Java package naming convention,
2018-07-03 18:14:26 +00:00
e.g. ``com.example.myapp.property``. This ensures property names are
suitably namespaced for each application and reduces the risk of
clashes.
2018-07-04 21:58:37 +00:00
Note that this endpoint is not necessarily handled by the homeserver,
but by another webserver, to be used for discovering the homeserver URL.
2018-07-03 18:14:26 +00:00
operationId: getWellknown
responses:
200:
description: Server discovery information.
2018-07-03 18:14:26 +00:00
examples:
application/json: {
"m.homeserver": {
"base_url": "https://matrix.example.com"
},
"m.identity_server": {
"base_url": "https://identity.example.com"
}
}
schema:
type: object
properties:
m.homeserver:
description: Information about the homeserver to connect to.
"$ref": "definitions/wellknown/homeserver.yaml"
m.identity_server:
2018-07-04 21:58:37 +00:00
description: Optional. Information about the identity server to connect to.
2018-07-03 18:14:26 +00:00
"$ref": "definitions/wellknown/identity_server.yaml"
2018-07-04 21:58:37 +00:00
additionalProperties:
description: Application-dependent keys using Java package naming convention.
required:
- m.homeserver
2018-07-03 18:14:26 +00:00
404:
description: No server discovery information available.
2018-07-03 18:14:26 +00:00
tags:
- Server administration