wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Specify how ordering of tags is supposed to work

Browse source
This commit is contained in:
Mark Haines 2015-11-16 17:04:19 +00:00
parent 3b390bff3c
commit 299af673da
5 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api/client-server/v1/rooms.yaml
View file

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

2
api/client-server/v1/sync.yaml
View file

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

2
api/client-server/v2_alpha/sync.yaml
View file

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

4
api/client-server/v2_alpha/tags.yaml
View file

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

5
specification/modules/tags.rst
View file

@ -21,6 +21,11 @@ the tags are for.
Each tag has an associated JSON object with information about the tag, e.g how Each tag has an associated JSON object with information about the tag, e.g how
to order the rooms with a given tag. 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}} {{m_tag_event}}
Client Behaviour Client Behaviour