matrix-spec/api/client-server/directory.yaml

# Copyright 2016 OpenMarket 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 Directory API"
  version: "1.0.0"
host: localhost:8008
schemes:
  - https
  - http
basePath: /_matrix/client/%CLIENT_MAJOR_VERSION%
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  $ref: definitions/security.yaml
paths:
  "/directory/room/{roomAlias}":
    put:
      summary: Create a new mapping from room alias to room ID.
      operationId: setRoomAlias
      security:
        - accessToken: []
      parameters:
        - in: path
          type: string
          name: roomAlias
          description: The room alias to set.
          required: true
          x-example: "#monkeys:matrix.org"
        - in: body
          name: body
          description: Information about this room alias.
          required: true
          schema:
            type: object
            properties:
              room_id:
                type: string
                description: The room ID to set.
            required: ['room_id']
            example: {
              "room_id": "!abnjk1jdasj98:capuchins.com"
            }
      responses:
        200:
          description: The mapping was created.
          examples:
            application/json: {}
          schema:
            type: object
        409:
          description: A room alias with that name already exists.
          examples:
            application/json: {
              "errcode": "M_UNKNOWN",
              "error": "Room alias #monkeys:matrix.org already exists."
            }
          schema:
            "$ref": "definitions/errors/error.yaml"
      tags:
        - Room directory
    get:
      summary: Get the room ID corresponding to this room alias.
      description: |-
        Requests that the server resolve a room alias to a room ID.

        The server will use the federation API to resolve the alias if the
        domain part of the alias does not correspond to the server's own
        domain.

      operationId: getRoomIdByAlias
      parameters:
        - in: path
          type: string
          name: roomAlias
          description: The room alias.
          required: true
          x-example: "#monkeys:matrix.org"
      responses:
        200:
          description: The room ID and other information for this alias.
          schema:
            type: object
            properties:
              room_id:
                type: string
                description: The room ID for this room alias.
              servers:
                type: array
                description: A list of servers that are aware of this room alias.
                items:
                  type: string
                  description: A server which is aware of this room alias.
          examples:
            application/json: {
                "room_id": "!abnjk1jdasj98:capuchins.com",
                "servers": [
                  "capuchins.com",
                  "matrix.org",
                  "another.com"
                ]
              }
        404:
          description: There is no mapped room ID for this room alias.
          examples:
            application/json: {
                "errcode": "M_NOT_FOUND",
                "error": "Room alias #monkeys:matrix.org not found."
              }
          schema:
            "$ref": "definitions/errors/error.yaml"
      tags:
        - Room directory
    delete:
      summary: Remove a mapping of room alias to room ID.
      description: |-
        Remove a mapping of room alias to room ID.

        Servers may choose to implement additional access control checks here, for instance that
        room aliases can only be deleted by their creator or a server administrator.

        .. Note::
           Servers may choose to update the ``alt_aliases`` for the ``m.room.canonical_alias``
           state event in the room when an alias is removed. Servers which choose to update the
           canonical alias event are recommended to, in addition to their other relevant permission
           checks, delete the alias and return a successful response even if the user does not
           have permission to update the ``m.room.canonical_alias`` event.

      operationId: deleteRoomAlias
      security:
        - accessToken: []
      parameters:
        - in: path
          type: string
          name: roomAlias
          description: The room alias to remove.
          required: true
          x-example: "#monkeys:matrix.org"
      responses:
        200:
          description: The mapping was deleted.
          examples:
            application/json: {
              }
          schema:
            type: object
        404:
          description: There is no mapped room ID for this room alias.
          examples:
            application/json: {
              "errcode": "M_NOT_FOUND",
              "error": "Room alias #monkeys:example.org not found."
            }
          schema:
            "$ref": "definitions/errors/error.yaml"
      tags:
        - Room directory
  "/rooms/{roomId}/aliases":
    get:
      summary: Get a list of local aliases on a given room.
      description: |-
        Get a list of aliases maintained by the local server for the
        given room.

        This endpoint can be called by users who are in the room (external
        users receive an ``M_FORBIDDEN`` error response). If the room's
        ``m.room.history_visibility`` maps to ``world_readable``, any
        user can call this endpoint.

        Servers may choose to implement additional access control checks here,
        such as allowing server administrators to view aliases regardless of
        membership.

        .. Note::
           Clients are recommended not to display this list of aliases prominently
           as they are not curated, unlike those listed in the ``m.room.canonical_alias``
           state event.

      operationId: getLocalAliases
      security:
        - accessToken: []
      parameters:
        - in: path
          type: string
          name: roomId
          description: The room ID to find local aliases of.
          required: true
          x-example: "!abc123:example.org"
      responses:
        200:
          description: |-
            The list of local aliases for the room.
          examples:
            application/json: {
              "aliases": [
                "#somewhere:example.com",
                "#another:example.com",
                "#hat_trick:example.com"
              ]
            }
          schema:
            type: object
            properties:
              aliases:
                type: array
                description: The server's local aliases on the room. Can be empty.
                items:
                  type: string
            required: ['aliases']
        403:
          description: The user is not permitted to retrieve the list of local aliases for the room.
          examples:
            application/json: {
              "errcode": "M_FORBIDDEN",
              "error": "You are not a member of the room."
            }
          schema:
            "$ref": "definitions/errors/error.yaml"
        429:
          description: This request was rate-limited.
          schema:
            "$ref": "definitions/errors/rate_limited.yaml"
      tags:
        - Room directory