matrix-spec/data/api/server-server/version.yaml

# Copyright 2017 Kamax.io
#
# 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 Version API
  version: 1.0.0
paths:
  /version:
    get:
      summary: Get the implementation name and version of this homeserver.
      description: Get the implementation name and version of this homeserver.
      operationId: getVersion
      responses:
        "200":
          description: The implementation name and version of this homeserver.
          content:
            application/json:
              schema:
                type: object
                properties:
                  server:
                    title: Server
                    type: object
                    properties:
                      name:
                        type: string
                        description: Arbitrary name that identify this implementation.
                      version:
                        type: string
                        description: Version of this implementation. The version format depends on the
                          implementation.
              examples:
                response:
                  value: {
                    "server": {
                      "name": "My_Homeserver_Implementation",
                      "version": "ArbitraryVersionNumber"
                    }
                  }
servers:
  - url: "{protocol}://{hostname}{basePath}"
    variables:
      protocol:
        enum:
          - http
          - https
        default: https
      hostname:
        default: localhost:8448
      basePath:
        default: /_matrix/federation/v1