From a1265a274b13384be5ac316d927adbdfe497461f Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Fri, 29 Sep 2017 11:59:27 -0600
Subject: [PATCH] Add spec for m.room.pinned_events

Signed-off-by: Travis Ralston <travpc@gmail.com>
---
 .gitignore                                  |  1 +
 event-schemas/examples/m.room.pinned_events | 12 ++++++++++
 event-schemas/schema/m.room.pinned_events   | 25 +++++++++++++++++++++
 3 files changed, 38 insertions(+)
 create mode 100644 event-schemas/examples/m.room.pinned_events
 create mode 100644 event-schemas/schema/m.room.pinned_events

diff --git a/.gitignore b/.gitignore
index daef51d7..dccd3152 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,4 @@
 /templating/out
 *.pyc
 *.swp
+/env
\ No newline at end of file
diff --git a/event-schemas/examples/m.room.pinned_events b/event-schemas/examples/m.room.pinned_events
new file mode 100644
index 00000000..6f41e97d
--- /dev/null
+++ b/event-schemas/examples/m.room.pinned_events
@@ -0,0 +1,12 @@
+{
+  "age": 242352,
+  "content": {
+    "pinned": ["$someevent:localhost"]
+  },
+  "state_key": "",
+  "origin_server_ts": 1431961217939,
+  "event_id": "$WLGTSEFSEF:localhost",
+  "type": "m.room.pinned_events",
+  "room_id": "!Cuyf34gef24t:localhost",
+  "sender": "@example:localhost"
+}
diff --git a/event-schemas/schema/m.room.pinned_events b/event-schemas/schema/m.room.pinned_events
new file mode 100644
index 00000000..7b4a0d61
--- /dev/null
+++ b/event-schemas/schema/m.room.pinned_events
@@ -0,0 +1,25 @@
+---
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: This event is used to "pin" particular events in a room for other participants to review later. The order of the pinned events is guaranteed and based upon the order supplied in the event. Clients should be aware that the current user may not be able to see some of the events pinned due to visibility settings in the room. Clients are responsible for determining if a particular event in the pinned list is displayable, and have the option to not display it if it cannot be pinned in the client.
+properties:
+  content:
+    properties:
+      pinned:
+        description: An ordered list of event IDs to pin.
+        items:
+          type: string
+        type: array
+    required:
+      - pinned
+    type: object
+  state_key:
+    description: A zero-length string.
+    pattern: '^$'
+    type: string
+  type:
+    enum:
+      - m.room.pinned_events
+    type: string
+title: Pinned events in a room
+type: object