matrix-spec-proposals/api/client-server/definitions/wellknown/full.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.
title: Discovery Information
description: |-
  Used by clients to determine the homeserver, identity server, and other
  optional components they should be interacting with.  
type: object
properties:
  "m.homeserver":
    $ref: "homeserver.yaml"
  "m.identity_server":
    $ref: "identity_server.yaml"
additionalProperties:
  type: object
  description: Application-dependent keys using Java package naming convention.
required:
  - m.homeserver
example: {
  "m.homeserver": {
    "base_url": "https://matrix.example.com"
  },
  "m.identity_server": {
    "base_url": "https://identity.example.com"
  },
  "org.example.custom.property": {
    "app_url": "https://custom.app.example.org"
  }
}