matrix-spec-proposals/api/client-server/v1/membership.yaml

swagger: '2.0'
info:
  title: "Matrix Client-Server v1 Room Membership API"
  version: "1.0.0"
host: localhost:8008
schemes:
  - https
  - http
basePath: /_matrix/client/api/v1
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  accessToken:
    type: apiKey
    description: The user_id or application service access_token
    name: access_token
    in: query
paths:
  "/room/{roomId}/join":
    post:
      summary: Start the requesting user participating in a particular room.
      description: |-
        This API starts a user participating in a particular room, if that user
        is allowed to participate in that room. After this call, the client is
        allowed to see all current state events in the room, and all subsequent
        events associated with the room until the user leaves the room.
      security:
        - accessToken: []
      parameters:
        - in: path
          type: string
          name: roomId
          description: The room identifier or room alias to join.
          required: true
          x-example: "#monkeys:matrix.org"
      responses:
        200:
          description: |-
            The room has been joined.

            If the room was joined with an room alias, rather than a room ID,
            the room ID must be returned in the room_id field.

            If the room was joined with a room ID, the room_id field must not be
            present.
          examples:
            application/json: |-
              {"room_id": "!primates:matrix.org"}
          schema:
            type: object  # empty json object
        403:
          description: |-
            You do not have permission to join the room. A meaningful errcode and description error text will be returned. Example reasons for rejection are:
              - The room is invite-only and the user was not invited.
              - The user has been banned from the room.
          examples:
            application/json: |-
              {"errcode": "M_FORBIDDEN", "error": "You are not invited to this room."}
        429:
          description: This request was rate-limited.
          schema:
            "$ref": "definitions/error.yaml"
      x-aliases:
        - /join/{roomId}
      x-alias-link: "post-matrix-client-api-v1-room-roomid-join"
Spec /room/{roomId}/join This is just replacing the existing spec with a swagger version. Subsequent pull requests will add 3pid join to this, as well as specing the invite, leave, ban, and kick endpoints. 9 years ago			`swagger: '2.0'`
			`info:`
			`title: "Matrix Client-Server v1 Room Membership API"`
			`version: "1.0.0"`
			`host: localhost:8008`
			`schemes:`
			`- https`
			`- http`
			`basePath: /_matrix/client/api/v1`
			`consumes:`
			`- application/json`
			`produces:`
			`- application/json`
			`securityDefinitions:`
			`accessToken:`
			`type: apiKey`
			`description: The user_id or application service access_token`
			`name: access_token`
			`in: query`
			`paths:`
			`"/room/{roomId}/join":`
			`post:`
			`summary: Start the requesting user participating in a particular room.`
			`description: \|-`
			`This API starts a user participating in a particular room, if that user`
			`is allowed to participate in that room. After this call, the client is`
			`allowed to see all current state events in the room, and all subsequent`
			`events associated with the room until the user leaves the room.`
			`security:`
			`- accessToken: []`
			`parameters:`
			`- in: path`
			`type: string`
			`name: roomId`
			`description: The room identifier or room alias to join.`
			`required: true`
			`x-example: "#monkeys:matrix.org"`
			`responses:`
			`200:`
			`description: \|-`
			`The room has been joined.`

			`If the room was joined with an room alias, rather than a room ID,`
			`the room ID must be returned in the room_id field.`

			`If the room was joined with a room ID, the room_id field must not be`
			`present.`
			`examples:`
			`application/json: \|-`
			`{"room_id": "!primates:matrix.org"}`
			`schema:`
			`type: object # empty json object`
			`403:`
			`description: \|-`
			`You do not have permission to join the room. A meaningful errcode and description error text will be returned. Example reasons for rejection are:`
			`- The room is invite-only and the user was not invited.`
			`- The user has been banned from the room.`
			`examples:`
			`application/json: \|-`
			`{"errcode": "M_FORBIDDEN", "error": "You are not invited to this room."}`
			`429:`
			`description: This request was rate-limited.`
			`schema:`
			`"$ref": "definitions/error.yaml"`
Use other-way-around alias format 9 years ago			`x-aliases:`
			`- /join/{roomId}`
Spec /room/{roomId}/join This is just replacing the existing spec with a swagger version. Subsequent pull requests will add 3pid join to this, as well as specing the invite, leave, ban, and kick endpoints. 9 years ago			`x-alias-link: "post-matrix-client-api-v1-room-roomid-join"`