6c66bfc755
As a side effect, I got rid of all of the horrible symlinks and just put in all of the proper relative paths. Because the horrible symlinks were horrible.
92 lines
2.8 KiB
YAML
92 lines
2.8 KiB
YAML
swagger: '2.0'
|
|
info:
|
|
title: "Matrix Client-Server v1 Room Leaving 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:
|
|
"/rooms/{roomId}/leave":
|
|
post:
|
|
summary: Stop the requesting user participating in a particular room.
|
|
description: |-
|
|
This API stops a user participating in a particular room.
|
|
|
|
If the user was already in the room, they will no longer be able to see
|
|
new events in the room. If the room requires an invite to join, they
|
|
will need to be re-invited before they can re-join.
|
|
|
|
If the user was invited to the room, but had not joined, this call
|
|
serves to reject the invite.
|
|
|
|
The user will still be allowed to retrieve history from the room which
|
|
they were previously allowed to see.
|
|
security:
|
|
- accessToken: []
|
|
parameters:
|
|
- in: path
|
|
type: string
|
|
name: roomId
|
|
description: The room identifier to leave.
|
|
required: true
|
|
x-example: "!nkl290a:matrix.org"
|
|
responses:
|
|
200:
|
|
description: |-
|
|
The room has been left.
|
|
examples:
|
|
application/json: |-
|
|
{}
|
|
schema:
|
|
type: object
|
|
429:
|
|
description: This request was rate-limited.
|
|
schema:
|
|
"$ref": "definitions/error.yaml"
|
|
"/rooms/{roomId}/forget":
|
|
post:
|
|
summary: Stop the requesting user remembering about a particular room.
|
|
description: |-
|
|
This API stops a user remembering about a particular room.
|
|
|
|
In general, history is a first class citizen in Matrix. After this API
|
|
is called, however, a user will no longer be able to retrieve history
|
|
for this room. If all users on a homeserver forget a room, the room is
|
|
eligible for deletion from that homeserver.
|
|
|
|
If the user is currently joined to the room, they will implicitly leave
|
|
the room as part of this API call.
|
|
security:
|
|
- accessToken: []
|
|
parameters:
|
|
- in: path
|
|
type: string
|
|
name: roomId
|
|
description: The room identifier to forget.
|
|
required: true
|
|
x-example: "!au1ba7o:matrix.org"
|
|
responses:
|
|
200:
|
|
description: |-
|
|
The room has been forgotten.
|
|
examples:
|
|
application/json: |-
|
|
{}
|
|
schema:
|
|
type: object
|
|
429:
|
|
description: This request was rate-limited.
|
|
schema:
|
|
"$ref": "definitions/error.yaml"
|