Allow room tags to have asssociated content, and return that content in the m.tag events

api/client-server/v2_alpha/tags.yaml

@@ -49,16 +49,15 @@ paths:
             type: object
             properties:
               tags:
-                type: array
+                title: Tags
-                items:
+                type: object
-                  type: string
           examples:
             application/json: |-
               {
-                "tags": [
+                "tags": {
-                  "work",
+                  "work": {"order": 1},
-                  "pinned"
+                  "pinned": {}
-                ]
+                }
               }
   "/user/{userId}/rooms/{roomId}/tags/{tag}":
     put:
@@ -94,11 +93,11 @@ paths:
           name: body
           required: true
           description: |-
-            An empty JSON object.
+            Extra data for the tag, e.g. ordering.
           schema:
             type: object
             example: |-
-              {}
+              {"order": 1}
       responses:
         200:
           description:

event-schemas/examples/v1/m.tag

@@ -1,8 +1,8 @@
 {
   "type": "m.tag",
   "content": {
-    "tags": [
+    "tags": {
-      "work"
+      "work": {}
-    ]
+    }
   }
 }

event-schemas/schema/v1/m.tag

@@ -11,9 +11,10 @@
       "type": "object",
       "properties": {
         "tags": {
-          "type": "array",
+          "type": "object",
-          "items": {
+          "additionalProperties": {
-            "type": "string"
+            "title": "Tag",
+            "type": "object"
           }
         }
       }

specification/modules/tags.rst

@@ -18,6 +18,9 @@ The ``m.tag`` can also be received in a v1 /events response or in the
 events appearing in v1 /events will have a ``room_id`` with the room
 the tags are for.
 
+Each tag has an associated JSON object with information about the tag, e.g how
+to order the tags.
+
 {{m_tag_event}}
 
 Client Behaviour