From 03b8c7a12b0ce16bb6b720ba556b6ca78c3fc5a5 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 4 Sep 2015 11:43:11 +0100 Subject: [PATCH 1/4] Document the canonical alias event --- .../examples/v1/m.room.canonical_alias | 12 ++++++++ .../schema/v1/m.room.canonical_alias | 30 +++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 event-schemas/examples/v1/m.room.canonical_alias create mode 100644 event-schemas/schema/v1/m.room.canonical_alias diff --git a/event-schemas/examples/v1/m.room.canonical_alias b/event-schemas/examples/v1/m.room.canonical_alias new file mode 100644 index 00000000..9fd170d9 --- /dev/null +++ b/event-schemas/examples/v1/m.room.canonical_alias @@ -0,0 +1,12 @@ +{ + "age": 242352, + "content": { + "alias": "#somewhere:localhost" + }, + "state_key": "", + "origin_server_ts": 1431961217939, + "event_id": "$WLGTSEFSEF:localhost", + "type": "m.room.aliases", + "room_id": "!Cuyf34gef24t:localhost", + "user_id": "@example:localhost" +} diff --git a/event-schemas/schema/v1/m.room.canonical_alias b/event-schemas/schema/v1/m.room.canonical_alias new file mode 100644 index 00000000..bca91aa7 --- /dev/null +++ b/event-schemas/schema/v1/m.room.canonical_alias @@ -0,0 +1,30 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "title": "Informs the room as to which alias is the canonical one.", + "description": "This event is used to inform the room about which alias should be considered the canonical one. This could be for display purposes or as suggestion to users which alias to use to advertise the room.", + "allOf": [{ + "$ref": "core#/definitions/state_event" + }], + "properties": { + "content": { + "type": "object", + "properties": { + "alias": { + "type": "String", + "description": "The canonical alias.", + } + }, + "required": ["alias"] + }, + "state_key": { + "type": "string", + "description": "A zero-length string.", + "pattern": "^$" + }, + "type": { + "type": "string", + "enum": ["m.room.canonical_alias"] + } + } +} From 61f1424124a2643fcbb0d55f6e8df93a06b162df Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 4 Sep 2015 11:51:13 +0100 Subject: [PATCH 2/4] No trailing commas --- event-schemas/schema/v1/m.room.canonical_alias | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/event-schemas/schema/v1/m.room.canonical_alias b/event-schemas/schema/v1/m.room.canonical_alias index bca91aa7..2f8c0c36 100644 --- a/event-schemas/schema/v1/m.room.canonical_alias +++ b/event-schemas/schema/v1/m.room.canonical_alias @@ -12,7 +12,7 @@ "properties": { "alias": { "type": "String", - "description": "The canonical alias.", + "description": "The canonical alias." } }, "required": ["alias"] From 3aabb77cb4679fee642bd7c0a915a60f6eac1309 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 4 Sep 2015 11:53:07 +0100 Subject: [PATCH 3/4] Capitilasation matters --- event-schemas/schema/v1/m.room.canonical_alias | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/event-schemas/schema/v1/m.room.canonical_alias b/event-schemas/schema/v1/m.room.canonical_alias index 2f8c0c36..9f044e58 100644 --- a/event-schemas/schema/v1/m.room.canonical_alias +++ b/event-schemas/schema/v1/m.room.canonical_alias @@ -11,7 +11,7 @@ "type": "object", "properties": { "alias": { - "type": "String", + "type": "string", "description": "The canonical alias." } }, From 40f037da55e01b03af466ab9072973e9603954a8 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 4 Sep 2015 11:54:53 +0100 Subject: [PATCH 4/4] Get the right type --- event-schemas/examples/v1/m.room.canonical_alias | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/event-schemas/examples/v1/m.room.canonical_alias b/event-schemas/examples/v1/m.room.canonical_alias index 9fd170d9..0203a851 100644 --- a/event-schemas/examples/v1/m.room.canonical_alias +++ b/event-schemas/examples/v1/m.room.canonical_alias @@ -6,7 +6,7 @@ "state_key": "", "origin_server_ts": 1431961217939, "event_id": "$WLGTSEFSEF:localhost", - "type": "m.room.aliases", + "type": "m.room.canonical_alias", "room_id": "!Cuyf34gef24t:localhost", "user_id": "@example:localhost" }