Specify how ordering of tags is supposed to work

api/client-server/v1/rooms.yaml

@@ -314,7 +314,7 @@ paths:
                 "visibility": "private",
                 "private_user_data": [{
                     "type": "m.tag",
-                    "content": {"tags": {"work": {"order": 1}}}
+                    "content": {"tags": {"work": {"order": "1"}}}
                 }]
               }
           schema:

api/client-server/v1/sync.yaml

@@ -248,7 +248,7 @@ paths:
                           "visibility": "private",
                           "private_user_data": [{
                             "type": "m.tag",
-                            "content": {"tags": {"work": {"order": 1}}}
+                            "content": {"tags": {"work": {"order": "1"}}}
                           }]
                       }
                   ]

api/client-server/v2_alpha/sync.yaml

@@ -291,7 +291,7 @@ paths:
                         "events": [
                           {
                             "type": "m.tags",
-                            "content": {"tags": {"work": {"order": 1}}}
+                            "content": {"tags": {"work": {"order": "1"}}}
                           }
                         ]
                       }

api/client-server/v2_alpha/tags.yaml

@@ -55,7 +55,7 @@ paths:
             application/json: |-
               {
                 "tags": {
-                  "work": {"order": 1},
+                  "work": {"order": "1"},
                   "pinned": {}
                 }
               }
@@ -97,7 +97,7 @@ paths:
           schema:
             type: object
             example: |-
-              {"order": 1}
+              {"order": "1"}
       responses:
         200:
           description:

specification/modules/tags.rst

@@ -21,6 +21,11 @@ the tags are for.
 Each tag has an associated JSON object with information about the tag, e.g how
 to order the rooms with a given tag.
 
+Ordering information is given under the ``order`` key as a string. The string
+are compared lexicographically by unicode codepoint to determine which should
+displayed first. So a tag with an ``order`` key of ``"apples"`` would appear
+before a tag with an ``order`` key of ``"oranges"``.
+
 {{m_tag_event}}
 
 Client Behaviour