mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
ca9c376076
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
* Clarify Well-Known URIs Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com> * Fix section link --------- Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
70 lines
2.7 KiB
YAML
70 lines
2.7 KiB
YAML
# Copyright 2019 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.
|
|
openapi: 3.1.0
|
|
info:
|
|
title: Matrix Federation Server Discovery API
|
|
version: 1.0.0
|
|
paths:
|
|
/matrix/server:
|
|
get:
|
|
summary: Gets information about the delegated server for server-server
|
|
communication.
|
|
description: |-
|
|
Gets information about the delegated server for server-server communication
|
|
between Matrix homeservers. Servers should follow 30x redirects, carefully
|
|
avoiding redirect loops, and use normal X.509 certificate validation.
|
|
|
|
{{% boxes/note %}}
|
|
This endpoint should be accessed with the hostname of the homeserver's
|
|
[server name](/appendices/#server-name) by making a
|
|
GET request to `https://hostname/.well-known/matrix/server`.
|
|
{{% /boxes/note %}}
|
|
operationId: getWellKnown
|
|
responses:
|
|
"200":
|
|
description: The delegated server information. The `Content-Type` for this
|
|
response SHOULD be `application/json`, however servers parsing the
|
|
response should assume that the body is JSON regardless of type.
|
|
Failures parsing the JSON or invalid data provided in the resulting
|
|
parsed JSON should not result in discovery failure - consult the
|
|
server discovery process for information on how to continue.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
m.server:
|
|
type: string
|
|
description: |-
|
|
The server name to delegate server-server communications to, with optional
|
|
port. The delegated server name uses the same grammar as
|
|
[server names in the appendices](/appendices/#server-name).
|
|
examples:
|
|
response:
|
|
value: {
|
|
"m.server": "delegated.example.com:1234"
|
|
}
|
|
servers:
|
|
- url: "{protocol}://{hostname}{basePath}"
|
|
variables:
|
|
protocol:
|
|
enum:
|
|
- http
|
|
- https
|
|
default: https
|
|
hostname:
|
|
default: localhost
|
|
basePath:
|
|
default: /.well-known
|