mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-26 19:08:38 +01:00
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
47 lines
1.6 KiB
YAML
47 lines
1.6 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 Client-Server Server Discovery API"
|
|
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
|
|
additional keys, which MUST follow the Java package naming convention,
|
|
e.g. ``com.example.myapp.property``. This ensures property names are
|
|
suitably namespaced for each application and reduces the risk of
|
|
clashes.
|
|
|
|
Note that this endpoint is not necessarily handled by the homeserver,
|
|
but by another webserver, to be used for discovering the homeserver URL.
|
|
operationId: getWellknown
|
|
responses:
|
|
200:
|
|
description: Server discovery information.
|
|
schema:
|
|
"$ref": "definitions/wellknown/full.yaml"
|
|
404:
|
|
description: No server discovery information available.
|
|
tags:
|
|
- Server administration
|