From 13320cd33b9bd9a57bd404559b7baa64c0a7c4f2 Mon Sep 17 00:00:00 2001
From: Silas Davis <github@silasdavis.net>
Date: Tue, 31 Jan 2017 14:16:18 +0000
Subject: [PATCH] Add sub_id parameter

fixes #443
---
 docs/specs/api.md | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/docs/specs/api.md b/docs/specs/api.md
index 0946d9d2..30869583 100644
--- a/docs/specs/api.md
+++ b/docs/specs/api.md
@@ -1159,7 +1159,7 @@ TODO
 <a name="event-subscribe"></a>
 ####EventSubscribe
 
-Subscribe to a given type of event.
+Subscribe to a given type of event. The event is identified by the `event_id` (see [Event types](#event-types). The response provides a subscription identifier `sub_id` which tracks your client and can be used to [unsubscribe](#eventunsubscribe).
 
 #####HTTP
 
@@ -1196,9 +1196,9 @@ For more information about events and the event system, see the [Event system](#
 ***
 
 <a name="event-unsubscribe"></a>
-####EventUnubscribe
+####EventUnsubscribe
 
-Unsubscribe to an event type.
+Unsubscribe to an event by supplying the subscription identifier `sub_id` you obtained from a previous call to [subscribe](#eventsubscribe).
 
 #####HTTP
 
@@ -1210,7 +1210,12 @@ Endpoint: `/event_subs/:id`
 
 Method: `erisdb.eventUnsubscribe`
 
-Parameter: -
+Parameter:
+```
+{
+	sub_id: <string>
+}
+```
 
 #####Return value
 
@@ -2073,4 +2078,4 @@ One that finds those where 0 <= balance <= 1000.
 
 One that finds non-contract accounts with 0 <= balance <= 1000:
 
-`q=balance:0..1000+code:`
\ No newline at end of file
+`q=balance:0..1000+code:`
-- 
GitLab