From 6763317e64645945224b7c68ac385ed055fe80c3 Mon Sep 17 00:00:00 2001
From: Daniel Wagner-Hall <daniel@matrix.org>
Date: Tue, 17 Nov 2015 10:33:46 -0500
Subject: [PATCH] Specify /rooms/:room_id/forget

---
 api/client-server/v1/leaving.yaml | 35 +++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/api/client-server/v1/leaving.yaml b/api/client-server/v1/leaving.yaml
index 376b2060..e81d812b 100644
--- a/api/client-server/v1/leaving.yaml
+++ b/api/client-server/v1/leaving.yaml
@@ -55,3 +55,38 @@ paths:
           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"