updates to documentation

stashboard/templates/publicdoc/events.html

@@ -16,12 +16,15 @@ <h3>Attributes</h3>
     <dd>The URL of the specific event resource</dd>
     <dt>status</dt>
     <dd>The status of this event, as described by the Statuses resource</dd>
+    <dt>informational</dt>
+    <dd>This determines if event is a note or event</dd>
   </dl>
   <h3>List all events for a service</h3>
   <blockquote>GET /api/v1/services/{service-id}/events</blockquote>
   <pre><code>{
     "events": [
         {
+            "informational": false,
             "timestamp": "Mon, 28 Jun 2010 22:17:06 GMT",
             "message": "Problem fixed", 
             "sid": "ahJpc215d2Vic2VydmljZWRvd25yCwsSBUV2ZW50GBAM",
@@ -36,6 +39,7 @@ <h3>List all events for a service</h3>
             },
         }, 
         {
+            "informational": false,
             "timestamp": "Mon, 28 Jun 2010 22:18:06 GMT",
             "message": "Might be up", 
             "sid": "ahJpc215d2Vic2VydmljZWRvd25yCwsSBUV2ZW50GA8M",
@@ -65,8 +69,9 @@ <h3>Filter Options</h3>
   <blockquote>GET /api/v1/services/{service-id}/events?end=2010-06-17&start=2010-06-01</blockquote>
   <p>Return all events between June 6, 2010 and June 17, 2010</p>
   <h3>Get the current event for a service</h3>
-  <blockquote>GET /api/v1/services/{service-id}/current</blockquote>
+  <blockquote>GET /api/v1/services/{service-id}/events/current</blockquote>
   <pre><code>{
+    "informational": true,
     "timestamp": "Mon, 28 Jun 2010 22:17:06 GMT",
     "message": "Might be up", 
     "sid": "ahJpc215d2Vic2VydmljZWRvd25yCwsSBUV2ZW50GA8M",
@@ -83,6 +88,7 @@ <h3>Get the current event for a service</h3>
   <h3>Get an individual event</h3>
   <blockquote>GET /api/v1/services/{service-id}/events/{event-sid}</blockquote>
   <pre><code>{
+    "informational": false,
     "timestamp": "Mon, 28 Jun 2010 22:17:06 GMT",
     "message": "Might be up", 
     "sid": "ahJpc215d2Vic2VydmljZWRvd25yCwsSBUV2ZW50GA8M",

stashboard/templates/publicdoc/services.html

@@ -12,8 +12,8 @@ <h3>Attributes</h3>
     <dd>The name of the service, defined by the user</dd>
     <dt>description</dt>
     <dd>The description of the web service</dd>
-    <dt>service-list<dt>
-    <dd>The <a href="#">service list</a> this service belongs to, if any</dd>
+    <dt>list<dt>
+    <dd>The <a href="/documentation/service-lists">service list</a> this service belongs to, if any</dd>
     <dt>current-event</dt>
     <dd>The current event for the service, if any</dd>
     <dt>url</dt>

stashboard/templates/publicdoc/status-images.html

@@ -8,23 +8,23 @@ <h3>Attributes</h3>
   <dl>
     <dt>name</dt>
     <dd>The name of the status image</dd> 
-    <dt>set</dt>
+    <dt>icon_set</dt>
     <dd>The icon set this image belongs to</dd>
     <dt>url</dt>
     <dd>The image URL<dd>
   </dl>
   <h3>List all status images</h3>
-  <blockquote>GET /api/v1/statuses</blockquote>
+  <blockquote>GET /api/v1/status-images</blockquote>
   <pre><code>{
     "images": [
         {
             "url": "http://status.twilio.com/images/icons/fugue/broom.png",
-            "set": "fugue",
+            "icon_set": "fugue",
             "name": "broom"
         },
         {
             "url": "http://status.twilio.com/images/icons/fugue/flag.png",
-            "set": "fugue",
+            "icon_set": "fugue",
             "name": "flag"
         },
     ]

stashboard/templates/publicdoc/statuses.html

@@ -18,6 +18,8 @@ <h3>Attributes</h3>
     <dd>The level of this status. Can be any value listed in the Levels List resource</dd>
     <dt>image</dt>
     <dd>The URL of the image for this status</dd>
+    <dt>default</dt>
+    <dd>Defines the status as default</dd>
   </dl>
   <h3>List all statuses</h3>
   <blockquote>GET /api/v1/statuses</blockquote>
@@ -30,6 +32,7 @@ <h3>List all statuses</h3>
             "level": "NORMAL",
             "image": "/images/status/tick-circle.png",
             "url": "api/v1/statuses/up",
+            "default": true,
         },
         {
             "name": "Down",
@@ -38,6 +41,7 @@ <h3>List all statuses</h3>
             "level": "ERROR",
             "image": "/images/status/cross-circle.png",
             "url": "api/v1/statuses/down",
+            "default": false,
         },
     ]
 }</code></pre>
@@ -50,6 +54,7 @@ <h3>Get an individual status</h3>
     "level": "ERROR",
     "image": "/images/status/cross-circle.png",
     "url": "/api/v1/statuses/down",
+    "default": false,
 }</code></pre>
 </section>
 {% endblock %}