Note that m.tag events can appear in v1 initialSync and /events as we…

…ll as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync
matrix-org · Nov 2, 2015 · f557e69 · f557e69
1 parent ad86426
commit f557e69
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/api/client-server/v1/sync.yaml b/api/client-server/v1/sync.yaml
@@ -248,8 +248,7 @@ paths:
                           "visibility": "private",
                           "private_user_data": [{
                             "type": "m.tag",
-                            "content": {"tags": ["work"]},
-                            "room_id": "!TmaZBKYIFrIPVGoUYp:localhost"
+                            "content": {"tags": ["work"]}
                           }]
                       }
                   ]

diff --git a/specification/modules/tags.rst b/specification/modules/tags.rst
@@ -10,8 +10,13 @@ user that set them but are shared across all their devices.
 Events
 ------
 
-The tags on a room are passed as single ``m.tag`` event in the
-``private_user_data`` section of a room in v2 sync.
+The tags on a room are receieved as single ``m.tag`` event in the
+``private_user_data`` section of a room in a v2 /sync.
+
+The ``m.tag`` can also be received in a v1 /events response or in the
+``private_user_data`` section of a room in v1 /initialSync. ``m.tag``
+events appearing in v1 /events will have a ``room_id`` with the room
+the tags are for.
 
 {{m_tag_event}}