matrix-spec/data/api/client-server/list_joined_rooms.yaml

# Copyright 2017 Michael Telatynski <7t3chguy@gmail.com>
#
# 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 Client-Server Room Listing API
  version: 1.0.0
paths:
  /joined_rooms:
    get:
      summary: Lists the user's current rooms.
      description: This API returns a list of the user's current rooms.
      operationId: getJoinedRooms
      security:
        - accessTokenQuery: []
        - accessTokenBearer: []
      responses:
        "200":
          description: A list of the rooms the user is in.
          content:
            application/json:
              schema:
                type: object
                required:
                  - joined_rooms
                properties:
                  joined_rooms:
                    type: array
                    description: The ID of each room in which the user has `joined` membership.
                    items:
                      type: string
              examples:
                response:
                  value: {
                    "joined_rooms": [
                      "!foo:example.com"
                    ]
                  }
      tags:
        - Room membership
servers:
  - url: "{protocol}://{hostname}{basePath}"
    variables:
      protocol:
        enum:
          - http
          - https
        default: https
      hostname:
        default: localhost:8008
      basePath:
        default: /_matrix/client/v3
components:
  securitySchemes:
    accessTokenQuery:
      $ref: definitions/security.yaml#/accessTokenQuery
    accessTokenBearer:
      $ref: definitions/security.yaml#/accessTokenBearer