Merge pull request #88 from matrix-org/markjh/initial_sync_archived_flag

Add flag to initial sync to say we want rooms that the user has left
matrix-org · Oct 9, 2015 · d6bdde4 · d6bdde4
2 parents 51ab51a + d42c319
commit d6bdde4
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/api/client-server/v1/sync.yaml b/api/client-server/v1/sync.yaml
@@ -39,6 +39,16 @@ paths:
           description: The maximum time in milliseconds to wait for an event.
           required: false
           x-example: "35000"
+        - in: query
+          type: string
+          name: archived
+          description: |-
+            Whether to include rooms that the user has left. If absent then
+            only rooms that the user has been invited to or has joined are
+            included. If set to "true" then rooms that the user has left are
+            included as well.
+          required: false
+          x-example: "true"
       responses:
         200:
           description: "The events received, which may be none."